LISTSERV mailing list manager LISTSERV 16.5

Help for HPS-SOFTWARE Archives


HPS-SOFTWARE Archives

HPS-SOFTWARE Archives


HPS-SOFTWARE@LISTSERV.SLAC.STANFORD.EDU


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

HPS-SOFTWARE Home

HPS-SOFTWARE Home

HPS-SOFTWARE  March 2015

HPS-SOFTWARE March 2015

Subject:

guidelines for not breaking things

From:

"McCormick, Jeremy I." <[log in to unmask]>

Reply-To:

Software for the Heavy Photon Search Experiment <[log in to unmask]>

Date:

Sun, 8 Mar 2015 03:45:39 +0000

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (75 lines)

Hi,

As the person who is probably responsible for breaking the most things in HPS Java, I thought I’d share some thoughts about how not to break things going forward.

1) Always run the tests before big checkins

There are integration tests in HPS Java, and at this point some of them actually do useful things, like asserting that a certain number of reconstruction objects must be present in output.  Before making major changes run the build from trunk with the ‘mvn’ command so that all tests are activated.  This will make sure your changes do not fundamentally break anything.

2) Keep an eye on the Hudson builds

When the Hudson builds fail, this usually means that a compilation error occurred, which can mean you have introduced build errors into the project.  (Sometimes Hudson has strange errors having to do with filesystem issues but this is usually easily spotted).  

An “unstable” build means that the build worked but one or more tests failed.  

For instance, you can see the list of the latest test results here.

http://srs.slac.stanford.edu/hudson/view/HPS/job/hps-modules/lastBuild/testReport/

If you have checked in new code and the tests all of a sudden start failing, it is worth investigating why, as your code may have broken something.

3) Make sure you have checked in all your local, required changes

Sometimes you might checkin code and forget some piece of it, like a file that was never added using ‘svn add’ or a modification to some class that is required with your other changes.  These types of problems are usually easily spotted if your build is working fine but Hudson is failing.  Use ‘svn status’ to tell which files you have locally modified which are not in sync with SVN and then commit the missing changes to fix this.

4) Write test cases

It is worth writing test cases for your code and having them run with the build.  I think I have harped on this enough to not need to explain why.

We are particularly deficient in this area when it comes to converting from the raw EVIO data to LCIO, so we should think about adding some in-depth tests in this area soon, as breakage in the event builders can essentially make the entire reconstruction non-functional.

5) Be careful with changes to LCSim

There are some low level classes in LCSim which when changed can cause fundamental problems in our software.  In particular, any modifications to the base implementations of the reconstruction classes like Track or Cluster, major alterations to detector model code, etc. can cause issues in any classes that depend on them.     Aside from new detector model code, which is sometimes required, any major modifications to this project should be discussed first.

6) Branch the code

The way that SVN works, you cannot stage a commit like with git.  So it is possible to make a series of commits, one of which breaks the build, but altogether they would not.  The proper way to get around this is to branch the code, either the entire trunk or individual modules, and then make incremental commits on those branches where you can leave things broken and not affect anyone else’s copy of the trunk.  Then, when the project is completed on the branch, you can merge it back in.

For instance, you can branch the entire trunk as follows….

svn cp -m “Branching HPS Java for fun and profit.” svn://svn.freehep.org/hps/java/trunk svn://svn.freehep.org/hps/java/branches/hps-java-HPSJAVA-123

It is a good idea to assign a JIRA item to the project you’re working on and use it for the branch name.

Then when you’re done checking in changes on the branch, you can merge them back into trunk.

cd trunk; svn merge svn://svn.freehep.org/hps/java/branches/hps-java-HPSJAVA-123 .

You need to then ‘svn commit’ those changes as merge does not commit them.  It is best to actually check which modifications were made from the merge locally before committing.

Or you can branch a single module…

svn cp -m “Branching the tracking to rewrite it in Ruby.” svn://svn.freehep.org/hps/java/trunk/tracking svn://svn.freehep.org/hps/java/branches/tracking-HPSJAVA-345

And merge it back similarly…

cd trunk/tracking; svn merge svn://svn.freehep.org/hps/java/branches/tracking-HPSJAVA-345 .

For projects isolated to a single module, it is best to only branch that module.  For anything that touches code in many modules, then you can branch the entire trunk.

If you have any questions about branching and merging, then don’t be afraid to ask.  This is a powerful tool for having a copy of the code that you can work on without introducing unwanted changes into the main “trunk”.

7) Don’t break the prod branch

We have just introduced a “prod” branch where changes will be vetted in trunk before being introduced.  This is for introducing some level of stability to the code running in the counting house.  That said, there is nothing special about this branch that will automatically prevent us from breaking the code on it, so be extra careful about which changes are merged into it going forward, and keep in mind some of the points mentioned above.

If there are any other suggestions here for improving things overall in this area, please let me know!

—Jeremy
########################################################################
Use REPLY-ALL to reply to list

To unsubscribe from the HPS-SOFTWARE list, click the following link:
https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=HPS-SOFTWARE&A=1

Top of Message | Previous Page | Permalink

Advanced Options


Options

Log In

Log In

Get Password

Get Password


Search Archives

Search Archives


Subscribe or Unsubscribe

Subscribe or Unsubscribe


Archives

March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
June 2022
April 2022
March 2022
February 2022
January 2022
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
December 2019
November 2019
October 2019
September 2019
August 2019
July 2019
June 2019
May 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
July 2018
June 2018
May 2018
April 2018
March 2018
February 2018
January 2018
December 2017
November 2017
October 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
October 2012
September 2012
August 2012
July 2012
June 2012
May 2012
April 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011

ATOM RSS1 RSS2



LISTSERV.SLAC.STANFORD.EDU

Secured by F-Secure Anti-Virus CataList Email List Search Powered by the LISTSERV Email List Manager

Privacy Notice, Security Notice and Terms of Use