Developer Info: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
 
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:


* [https://github.com/OPENDAP OPeNDAP's GitHub repositories]: OPeNDAP's software is available using GitHub in addition to the doenloads from our website.
* [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.
* [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.
* [http://test.opendap.org/ test.opendap.org]: Test servers with data files.
Line 10: Line 11:
== OPeNDAP's FAQ ==
== OPeNDAP's FAQ ==
The [http://www.opendap.org/faq-page OPeNDAP FAQ] has a pretty good section on developer's questions.
The [http://www.opendap.org/faq-page OPeNDAP FAQ] has a pretty good section on developer's questions.
== C++ Coding Information ==
* [[Include files for libdap | Guidelines for including headers]]
* [[Using lambdas with the STL]]
* [[Better Unit tests for C++]]
* [[Better Singleton classes C++]]
* [[What is faster? stringstream string + String]]
* [[More about strings - passing strings to functions]]


== OPeNDAP Workshops ==
== OPeNDAP Workshops ==
Line 17: Line 26:


== libdap4 and BES Reference documentation ==
== libdap4 and BES Reference documentation ==
* [http://old.opendap.org/api/bes/html/index.html BES Reference]
* [https://opendap.github.io/bes/html/ BES Reference]
* [https://opendap.github.io/libdap4/html/ libdap Reference]
* [https://opendap.github.io/libdap4/html/ libdap Reference]


Line 29: Line 38:
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
* [[Hyrax - Starting and stopping the BES| Starting and stopping the BES]]
* [[Hyrax - Running bescmdln | Running the BES command line client]]
* [[Hyrax - Running bescmdln | Running the BES command line client]]
* [[Hyrax - BES Client commands| BES Client commands]]
* [[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).
* [[BES_XML_Commands | BES XML Commands]]
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]
* [[Hyrax - Extending BES Module | Extending your BES Module]]
* [[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 - 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)]]
* [[Hyrax - BES PPT | BES communication protocol using PPT (point to point transport)]]
* [[Hyrax:_BES_Administrative_Commands| BES Administrative Commands]]


* [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]]
* [[Australian BOM Software Developer's Agenda and Presentations|Software Developers Workshop]]
Line 41: Line 49:
These pages contain information about how we'd like people working with us to use our various on-line tools.
These pages contain information about how we'd like people working with us to use our various on-line tools.


* [[Planning a Program Increment]] This is a checklist for the planning phase that precedes a Program Increment (PI) when using SAFe with the NASA ESDIS development group.
* [[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.
* [[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.
* [[ReleaseSprintNotes | How to Plan a Release Sprint]] A general template for planning a release in Jira or the equivalent.
* [[ReleaseGuide | Making a Release]]. Once software is ready for distribution, use this checklist to make sure you do all of the steps needed to make a release.
* [[RPM |Making RPM Distributions]]. Follow these steps to create an RPM distribution of the software.
* [[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.
* [[Bug Prioritization]]. How we prioritize bugs in our software.
* [[Bug Prioritization]]. How we prioritize bugs in our software.


===== Software process issues: =====
===[[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.
 
== Software process issues: ==
* [[How to download test logs from a Travis build]] All of our builds on Travis that run tests save those logs to an S3 bucket.
* [[ConfigureCentos| How to configure a CentOS machine for production of RPM binaries]] - Updated 12/2014 to include information regarding git.
* [[ConfigureCentos| How to configure a CentOS machine for production of RPM binaries]] - Updated 12/2014 to include information regarding git.
* [[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.
* [[How to use CLion with our software]]
* [[BES Timing| How to add timing instrumentation to your BES code.]]
* [[BES Timing| How to add timing instrumentation to your BES code.]]
* [[UnitTests| How to write unit tests using CppUnit]]
* [[UnitTests| How to write unit tests using CppUnit]] NB: See other information under the heading of C++ development
* [[valgrind| How to use valgrind with unit tests]]
* [[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]]
* [[CopyRights| How to copyright software written for OPeNDAP]]
* [[Managing public and private keys using gpg]]
* [[Managing public and private keys using gpg]]
Line 61: Line 71:
* [http://semver.org/ Software version numbers]
* [http://semver.org/ Software version numbers]
* [[GuideLines| Development Guidelines]]
* [[GuideLines| Development Guidelines]]
* [[Apple M1 Special Needs]]
==== Older info of limited value: ====
* [http://gcc.gnu.org/gcc-4.4/cxx0x_status.html C++-11 gcc/++-4.4 support] We now require compilers that support C++-14, so this is outdated (4/19/23).
* [[How to use Eclipse with Hyrax Source Code]] I like Eclipse, but we now use CLion because it's better (4/19/23) . 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.


==== AWS Tips ====
==== AWS Tips ====
Line 69: Line 84:
These pages contain general information relevant to anyone working with our software:
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 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.
* [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.
* [[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.
Line 81: Line 101:


= Old information =
= Old information =
'''Note''': Old build information
====The Release Process====
# 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:
## Update version number for the <tt>hyrax-dependencies</tt> in the <tt>Makefile</tt>
## Save, commit, (merge?), and push the changes to the <tt>master</tt> branch.
## 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.
# [[Source_Release_for_libdap | Making a source release of libdap]]
# [[ReleaseGuide | Making a source release of the BES]].
# [[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.
# [[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.
====Supplemental release guides====
<font color="red">Old - use the packages built using the Continuous Delivery process</font>
# [[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.''
'''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...''
'''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...''
* [[MergingBranches |How to merge code]]
* [[MergingBranches |How to merge code]]

Latest revision as of 23:09, 22 February 2024

OPeNDAP's FAQ

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

C++ Coding Information

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.

libdap4 and BES Reference documentation

BES Development Information

OPeNDAP Development process information

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

  • Planning a Program Increment This is a checklist for the planning phase that precedes a Program Increment (PI) when using SAFe with the NASA ESDIS development group.
  • 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.

Making A Release

Software process issues:

Older info of limited value:

  • C++-11 gcc/++-4.4 support We now require compilers that support C++-14, so this is outdated (4/19/23).
  • How to use Eclipse with Hyrax Source Code I like Eclipse, but we now use CLion because it's better (4/19/23) . 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.

AWS Tips

General development information

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

Old information

Note: Old build information

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.

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...