Difference between revisions of "Developer Info"

From OPeNDAP Documentation
(Created page with " * [http://test.opendap.org/cgi-bin/build_reader.pl?show=current&sort=yes Nightly Builds]: Software we build every night on several platforms. The link provides the most recent r...")
 
(General development information)
 
(136 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
* [http://test.opendap.org/cgi-bin/build_reader.pl?show=current&sort=yes Nightly Builds]: Software we build every night on several platforms. The link provides the most recent report for each build we do. Use ''show=current'' to get the most recent; ''show=<date>'' to get a particular date, ''show=<platform>'' to see a particular platform. The ''sort=yes'' option runs the results through Unix sort before building the table. The nightly build software is part of the ''nbuilds'' project and is available from our trac/svn repository.
+
* [https://github.com/OPENDAP OPeNDAP's GitHub repositories]: OPeNDAP's software is available using GitHub in addition to the downloads from our website.
 +
** Before 2015 we hosted our own SVN repository. It's still online and available, but for read-only access, at [https://scm.opendap.org/svn https://scm.opendap.org/svn].
 +
* [https://travis-ci.org/OPENDAP Continuous Integration builds]: Software that is built whenever new changes are pushed to the master branch. These builds are done on the Travis-CI system.
 +
* [http://test.opendap.org/ test.opendap.org]: Test servers with data files.
 +
* We use the Coverity static system to look for common software defects, information on Hyrax is spread across three projects:
 +
** [https://scan.coverity.com/projects/opendap-bes?tab=overview The BES and the standard handlers we distribute]
 +
** [https://scan.coverity.com/projects/opendap-olfs?tab=overview The OLFS - the front end to the Hyrax data server]
 +
** [https://scan.coverity.com/projects/opendap-libdap4?tab=overview libdap - The implementation of DAP2 and DAP4]
 +
 
 +
== OPeNDAP's FAQ ==
 +
The [http://www.opendap.org/faq-page OPeNDAP FAQ] has a pretty good section on developer's questions.
 +
 
 +
== OPeNDAP Workshops ==
 +
* [http://www.opendap.org/about/workshops-and-presentations/2007-10-12 The APAC/BOM Workshops]: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
 +
* [http://www.opendap.org/about/workshops-and-presentations/2008-07-15 ESIP Federation Server Workshop]: This half-day workshop focused on server installation and configuration. Summer 2008
 +
* [[A One-day Course on Hyrax Development | Server Functions]]: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.
 +
 
 +
== libdap4 and BES Reference documentation ==
 +
* [https://opendap.github.io/bes/html/ BES Reference]
 +
* [https://opendap.github.io/libdap4/html/ libdap Reference]
 +
 
 +
== BES Development Information ==
 +
* [[Hyrax - Logging Configuration|Logging Configuration]]
 +
 
 +
* [[BES_-_How_to_Debug_the_BES| How to debug the BES]]
 +
* [[BES - Debugging Using besstandalone]]
 +
* [[Hyrax - Create BES Module | How to create your own BES Module]]
 +
* Hyrax Module Integration: How to configure your module so it's easy to add to Hyrax instances ([[:File:HyraxModuleIntegration-1.2.pdf|pdf]])
 +
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
 +
* [[Hyrax - Running bescmdln | Running the BES command line client]]
 +
* [[Hyrax - BES Client commands| BES Client commands]]. The page [[BES_XML_Commands | BES XML Commands]] repeats this info for a bit more information on the return values. Most of the commands don't return anything unless they return an error and are expected to be used in a group where a ''get'' command closes out the request and obviously does return a response of some kind (maybe an error).
 +
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]
 +
* [[Hyrax - Extending BES Module | Extending your BES Module]]
 +
* [[Hyrax - Example BES Modules | Example BES Modules]] - the Hello World example and the CSV data handler
 +
* [[Hyrax - BES PPT | BES communication protocol using PPT (point to point transport)]]
 +
 
 +
* [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]]
 +
 
 +
== OPeNDAP Development process information  ==
 +
These pages contain information about how we'd like people working with us to use our various on-line tools.
 +
 
 +
* [[Hyrax GitHub Source Build]] This explains how to clone our software from GitHub and build our code using a shell like bash. It also explains how to build the BES and all of the Hyrax 'standard' handlers in one operation, as well as how to build just the parts you need without cloning the whole set of repos. Some experience with 'git submodule' will make this easier, although the page explains everything.
 +
* [[Bug Prioritization]]. How we prioritize bugs in our software.
 +
 
 +
===[[How to Make a Release|Making A Release]] ===
 +
* [[How to Make a Release]] A general template for making a release. This references some of the pages below.
  
* [http://test.opendap.org/ test.opendap.org]: Test servers with data files.
+
== Software process issues: ==
 +
* [http://gcc.gnu.org/gcc-4.4/cxx0x_status.html C++-11 gcc/++-4.4 support] How much of C++-11 can I use and still have my code build on CentOS 6 (which uses gcc/++ 4.4 by default)
 +
* [[ConfigureCentos| How to configure a CentOS machine for production of RPM binaries]] - Updated 12/2014 to include information regarding git.
 +
* [[How to use CLion with our software]]
 +
* [[How to use Eclipse with Hyrax Source Code]] Assuming you have cloned our Hyrax code from GitHub, this explains how to setup eclipse so you can work fairly easily and switch back and forth between the shell, emacs and eclipse.
 +
* [[BES Timing| How to add timing instrumentation to your BES code.]]
 +
* [[UnitTests| How to write unit tests using CppUnit]]
 +
* [[valgrind| How to use valgrind with unit tests]]
 +
* [[Debugging the distcheck target]] Yes, this gets its own page...
 +
* [[CopyRights| How to copyright software written for OPeNDAP]]
 +
* [[Managing public and private keys using gpg]]
 +
* [[SecureEmail |How to Setup Secure Email and Sign Software Distributions]]
 +
* [[UserSupport|How to Handle Email-list Support Questions]]
 +
* [[NetworkServerSecurity |Security Policy and Related Procedures]]
 +
* [http://semver.org/ Software version numbers]
 +
* [[GuideLines| Development Guidelines]]
 +
 
 +
==== AWS Tips ====
 +
* [[Growing a CentOS Root Partition on an AWS EC2 Instance]]
 +
* [[How Shutoff the CentOS firewall]]
 +
 
 +
== General development information ==
 +
These pages contain general information relevant to anyone working with our software:
 +
 
 +
* '''[[Git Hacks and Tricks]]''': Information about using git and/or GitHub that seems useful and maybe not all that obvious.
 +
* [[Git Secrets]]: securing repositories from AWS secret key leaks.
 +
* [https://wiki.wxwidgets.org/Valgrind_Suppression_File_Howto Valgrind Suppression File Howto] How to build a suppressions file for valgrind.
 +
* [[Using a debugger for C++ with Eclipse on OS/X]] Short version: use lldbmi2 **Add info**
 +
* [[Using ASAN]] Short version, look [https://github.com/google/sanitizers/wiki/AddressSanitizerAndDebugger at the Google/GitHub pages] for useful environment variables **add text** On Centos, use yum install llvm to get the 'symbolizer' and try ''ASAN_OPTIONS=symbolize=1 ASAN_SYMBOLIZER_PATH=$(shell which llvm-symbolizer)''
 +
* [[How to use ''Instruments'' on OS/X to profile]] Updated 7/2018
 +
* [https://wiki.wxwidgets.org/Valgrind_Suppression_File_Howto Valgrind - How to generate suppression files for valgrind] This will quiet valgrind, keeping it from telling you OS/X or Linux (or the BES) is leaking memory.
 +
* [[Migrating source code from SVN to git]]: How to move a large project from SVN to git and keep the history, commits, branches and tags.
 +
* [https://developer.mozilla.org/en-US/docs/Eclipse_CDT Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project]. Updated in 2017, this is really good but be aware that it's specific to Mozilla so some of the tips don't apply. Hyrax (i.e., libdap4 and BES) also use their own build system (autotools + make) so most of the configuration information here is very apropos. See also [[How to use Eclipse with Hyrax Source Code]] below.
 +
* [https://jfearn.fedorapeople.org/en-US/RPM/4/html/RPM_Guide/index.html RPM Guide] The best one I'm found so far...
 +
* [https://autotools.io/index.html Autotools Myth busters] The best info on autotools I've found yet (covers ''autoconf'', ''automake'', ''libtool'' and ''pkg-config'').
 +
* The [https://www.gnu.org/software/autoconf/autoconf.html autoconf] manual
 +
* The [https://www.gnu.org/software/automake/ automake] manual
 +
* The [https://www.gnu.org/software/libtool/ libtool] manual
 +
* A good [https://lldb.llvm.org/lldb-gdb.html gdb to lldb cheat sheet] for those of us who know ''gdb'' but not ''lldb''.
  
== Developer Guidelines and Information ==
+
= Old information =
* Development process information
+
'''Note''': Old build information
** [wiki:TrunkDevelBranchRel Using the SVN trunk, branches and tags to manage releases].
+
====The Release Process====
** [wiki:ShrewBranchGuide Making a Branch of Shrew for a Server Release]. Releases should be made from a branch so that development can continue on the trunk and so that we can easily go back to the software that mad up a release, fix bugs, and release those fixes.
+
# Make sure the <tt>hyrax-dependencies</tt> project is up to date and tar balls on www.o.o. If there have been changes/updates:
** [wiki:ReleaseGuide Making a Source Release]. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a source release.
+
## Update version number for the <tt>hyrax-dependencies</tt> in the <tt>Makefile</tt>
** [wiki:LinuxBuildHostConfig How to configure a Linux machine to build Hyrax from SVN]
+
## Save, commit, (merge?), and push the changes to the <tt>master</tt> branch.
** [wiki:RPM Making RPM Distributions]. Follow these steps to create an RPM distribution of the software.
+
## Once the <tt>hyrax-dependencies</tt> CI build is finished, trigger CI builds for both <tt>libdap4</tt> and <tt>bes</tt> by pushing change(s) to the master branch of each.
** ~~[wiki:DMG Making MAC OSX dmg]. Follow these steps to make a .dmg file for a Mac OSX release.~~ Use the following link.
+
# [[Source_Release_for_libdap | Making a source release of libdap]]
** [http://docs.opendap.org/index.php/Hyrax_Package_for_OS-X Hyrax Package for OS-X]. This describes how to make a new OS/X 'metapackage' for Hyrax.
+
# [[ReleaseGuide | Making a source release of the BES]].  
** [wiki:XP Making Windows XP distributions]. Follow these directions to make Windows XP binaries.
+
# [[OLFSReleaseGuide| Make the OLFS release WAR file]]. Follow these steps to create the three .jar files needed for the OLFS release. Includes information on how to build the OLFS and how to run the tests.
** [wiki:OLFSReleaseGuide Making a Release of OLFS]. Follow these steps to create the three .jar files needed for the OLFS release. Includes information on how to build the OLFS and how to run the tests.
+
# [[HyraxDockerReleaseGuide|Make the official Hyrax Docker image for the release]] When the RPMs and the WAR file(s) are built and pushed to their respective download locations, make the Docker image of the release.
** [wiki:ReleaseToolbox Making a Matlab Ocean Toolbox Release].  Follow these steps when a new Matlab GUI version is ready to be released.  
 
  
* General development information
+
====Supplemental release guides====
** [wiki:ConfigureCentos How to configure a CentOS machine for production of RPM binaries]
+
<font color="red">Old - use the packages built using the Continuous Delivery process</font>
** [wiki:MergingBranches How to merge code]
+
# [[RPM |Make the RPM Distributions]]. Follow these steps to create an RPM distribution of the software. '''Note:''' ''Now we use packages built using CI/CD, so this checklist is no longer needed.''
** [wiki:CopyRights How to copyright software written for OPeNDAP]
 
** [wiki:GuideLines Development Guidelines]
 
** [wiki:SecureEmail How to Setup Secure Email and Sign Software Distributions]
 
** [wiki:UserSupport How to Handle Email-list Support Questions]
 
** [wiki:NetworkServerSecurity Security Policy and Related Procedures]
 
** [http://semver.org/ Software version numbers]
 
  
== About Subversion ==
+
'''Note''': ''The following is all about using Subversion and is out of date as of November 2014 when we switched to git. There are still good ideas here...''
** [wiki:SubVersionInfo OPeNDAP Subversion information] -- Information about using OPeNDAP's [http://scm.opendap.org:8090/trac/browser/ subversion repository].
+
* [[MergingBranches |How to merge code]]
** [http://svnbook.red-bean.com/ Subversion documentation] -- The official Subversion documentation; [http://svnbook.red-bean.com/en/1.1/svn-book.pdf PDF] and [http://svnbook.red-bean.com/en/1.1/index.html HTML].
+
* [[TrunkDevelBranchRel | Using the SVN trunk, branches and tags to manage releases]].
 +
* [[ShrewBranchGuide | Making a Branch of Shrew for a Server Release]]. Releases should be made from the trunk and moved to a branch once they are 'ready' so that development can continue on the trunk and so that we can easily go back to the software that mad up a release, fix bugs, and (re)release those fixes. In general, it's better to fix things like build issues, etc., discovered in the released software ''on the trunk'' and merge those down to the release branch to maintain consistency, re-release, etc. This also means that virtually all new feature development should take place on special ''feature'' branches, not the trunk.
 +
* [[Hyrax Package for OS-X]]. This describes how to make a new OS/X 'metapackage' for Hyrax.
 +
* [[XP| Making Windows XP distributions]]. Follow these directions to make Windows XP binaries.
 +
* [[ReleaseToolbox |Making a Matlab Ocean Toolbox Release]]. Follow these steps when a new Matlab GUI version is ready to be released.
 +
* [[Eclipse - How to Setup Eclipse in a Shrew Checkout]] This includes some build instructions
 +
* [[LinuxBuildHostConfig| How to configure a Linux machine to build Hyrax from SVN]]
 +
* [[ConfigureSUSE| How to configure a SUSE machine for production of RPM binaries]]
 +
* [[ConfigureAmazonLinuxAMI| How to configure an Amazon Linux AMI for EC2 Instance To Build Hyrax]]
 +
* [[TestOpendapOrg | Notes from setting up Hyrax on our new web host]]
 +
* [http://svnbook.red-bean.com/en/1.7/index.html Subversion 1.7 documentation] -- The official Subversion documentation; [http://svnbook.red-bean.com/en/1.1/svn-book.pdf PDF] and [http://svnbook.red-bean.com/en/1.1/index.html HTML].
 +
* [[OPeNDAP's Use of Trac]] -- How to use Trac's various features in the software development process.

Latest revision as of 22:29, 16 December 2020

1 OPeNDAP's FAQ

The OPeNDAP FAQ has a pretty good section on developer's questions.

2 OPeNDAP Workshops

  • The APAC/BOM Workshops: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
  • ESIP Federation Server Workshop: This half-day workshop focused on server installation and configuration. Summer 2008
  • Server Functions: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.

3 libdap4 and BES Reference documentation

4 BES Development Information

5 OPeNDAP Development process information

These pages contain information about how we'd like people working with us to use our various on-line tools.

  • Hyrax GitHub Source Build This explains how to clone our software from GitHub and build our code using a shell like bash. It also explains how to build the BES and all of the Hyrax 'standard' handlers in one operation, as well as how to build just the parts you need without cloning the whole set of repos. Some experience with 'git submodule' will make this easier, although the page explains everything.
  • Bug Prioritization. How we prioritize bugs in our software.

5.1 Making A Release

6 Software process issues:

6.1 AWS Tips

7 General development information

These pages contain general information relevant to anyone working with our software:

8 Old information

Note: Old build information

8.1 The Release Process

  1. Make sure the hyrax-dependencies project is up to date and tar balls on www.o.o. If there have been changes/updates:
    1. Update version number for the hyrax-dependencies in the Makefile
    2. Save, commit, (merge?), and push the changes to the master branch.
    3. Once the hyrax-dependencies CI build is finished, trigger CI builds for both libdap4 and bes by pushing change(s) to the master branch of each.
  2. Making a source release of libdap
  3. Making a source release of the BES.
  4. Make the OLFS release WAR file. Follow these steps to create the three .jar files needed for the OLFS release. Includes information on how to build the OLFS and how to run the tests.
  5. Make the official Hyrax Docker image for the release When the RPMs and the WAR file(s) are built and pushed to their respective download locations, make the Docker image of the release.

8.2 Supplemental release guides

Old - use the packages built using the Continuous Delivery process

  1. Make the RPM Distributions. Follow these steps to create an RPM distribution of the software. Note: Now we use packages built using CI/CD, so this checklist is no longer needed.

Note: The following is all about using Subversion and is out of date as of November 2014 when we switched to git. There are still good ideas here...