*** Still in development ***
Note: In the below steps, <version_branch>
should be replaced with the version branch of Daffodil you are working on based on the Branch Workflow.
Tester creates a new bug branch
$ git fetch --prune origin $ git checkout -b <relevant_branch_name> --track origin/<version_branch> |
Completing test development includes repeating the following steps many times until you are satisfied with your test coverage:
$ # edit files $ git add <files> $ git commit $ git fetch --prune origin $ git rebase origin/<version_branch> $ sbt test |
When creating tests it is helpful in sbt to only run a single test (or small group of tests) at a time:
From the sbt prompt:
> test-only [test class] -- --tests=<regex> |
For example:
> test-only edu.illinois.ncsa.daffodil.section15.choice_groups.TestChoice -- --tests=test_choiceDelim\d+ |
Please read A Note About Git Commit Messages for the correct commit message format. Please follow those standards, with the additional requirement that the last line should contain only the JIRA bug number preceded by an empty line, e.g. "\nDFDL-123". If there is more than one bug related to the commit, separate them with commas.
When finished creating tests, tester ensures changes work with the latest upstream
$ git fetch --prune origin $ git rebase origin/<version_branch> |
Tester squashes commits into a reasonable patchset.
$ git rebase -i origin/<version_branch> |
Please pay attention to commit message format
Tester ensures all tests pass
$ sbt test |
Tester sets <version_branch> branch to bug branch and pushes
$ git checkout <version_branch> $ git reset --hard <relevant_branch_name> $ git push origin <version_branch> # do not use the --force option here |
If commit was a bug fix or a test on <version_branch> and a newer version branch exists:
Tester merges the change into the newer version branch, and fixes any conflicts:
$ git checkout <new_version_branch> $ git merge <version_branch> |
Tester ensures all tests pass
$ sbt test |
If tests fail due to incorrect conflict resolution, changes should be made and amended to the merge commit until tests pass:
# make changes $ git add <files> $ git commit --amend |
Tester pushes changes
$ git push origin <new_version_branch> # do not use the --force option here |
Tester deletes bug branch
$ git branch -D <relevant_branch_name> |