Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.12 KB

checksums.md

File metadata and controls

72 lines (51 loc) · 2.12 KB
Raw

Checksums

Updating checksums

Each smart answer flow has a corresponding checksums file at test/data/NAME-files.yml for a smart answer called NAME. This file contains a list of the files that relate to this smart answer, along with a md5 hash of the file contents.

By tracking the related files, and their checksums, it is possible to check if a smart answer would be affected by a change by checking the checksums files that would be affected.

For example, if you make a code change, expecting to impact just one smart answer, by updating all the checksum files and then checking that the only one that has changed is for the relevant smart answer, this can help to check that no unintended side effects have occurred.

Updating all the checksum values

The following command will update all the checksum values for all smart answer flows.

rake checksums:update

Updating checksum values for specific smart answers

The update rake task can be given the names of the smart answers to update, in which case only those will be updated.

rake checksums:update[marriage-abroad,check-uk-visa]

Generating and altering checksum files

For a new smart answer

To generate the checksum file for a new smart answer flow, run:

rake checksums:add_files[NAME]

If the smart answer has additional files that are not included by default, these can be specified after the name. Glob patterns are supported, e.g. you can use foo/* to select the files in a directory.

rake checksums:add_files[NAME,foo,bar/*]

Adding files for an existing smart answer

To add files to the checksums file for an existing smart answer flow, run checksums:add_files specifying the name of the smart answer flow, and the files you wish to add. Glob patterns are supported. For example:

rake checksums:add_files[marriage-abroad,foo,bar/*]

Known Issues

For versions of ruby greater than 2.3.2, some hashes in the checksums file will be quoted. This is undesirable as ideally the output is consistent even when different versions of ruby are used. For the moment, please ensure to keep the quotation consistent.