Test Workflow

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

Once the code has been reviewed, checked in and the JIRA ticket has been updated as Resolved by Developer, the ticket will be assigned to the Test lead.
The Test Lead will assign the JIRA ticket to the appropriate Tester.
If the ticket pertains to a new feature, the Tester makes note of requirements associated with the ticket and finds any other requirements that are relevant.

Tester creates a new bug branch

$ git fetch --prune origin
$ git checkout -b <relevant_branch_name> --track origin/<version_branch>

Tester verifies any existing developer-created tests in scala-new and uses tests to better understand feature.
Tester moves developer-created tests from scala-new to scala.
Tester creates more tests to ensure completeness of test coverage.
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.
If a bug is found:
1. Make sure any associated tests are in scala-debug, not scala
2. Reopen JIRA ticket and provide the following:
  1. Expected result and actual result. Include error and traceback if applicable.
  2. Name and location of failing test(s)
3. Assign ticket to original developer
4. Once a Test Case has been written, make sure test execution has been documented, tying the failure back to a JIRA ticket.
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:
1. Tester merges the change into the newer version branch, and fixes any conflicts:
```
$ git checkout <new_version_branch>
$ git merge <version_branch>
```
2. 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
```
3. 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>
```
Tester enters new tests into the test tracking system.
If no bugs have been found through the course of testing, tester prepares ticket for closing, performing the following tasks:
1. Reference the new tests in the ticket
2. Add comment to ticket stating that there is now sufficient test coverage
3. Close ticket and leave assigned to yourself.

Space shortcuts

Child pages