Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add acceptance and unit testing #21

Merged
merged 29 commits into from
Apr 6, 2023
Merged

Add acceptance and unit testing #21

merged 29 commits into from
Apr 6, 2023

Conversation

mscottford
Copy link
Contributor

I have some new features that I'd like to add, and I wanted to make sure I kept all existing behavior in the process, so I added test coverage as a first step. This pull request brings the line coverage to ~85% and the branch coverage to about ~70%. Coverage is measured via simplecov integration and can be cleanly generated by running bundle exec rake.

@mscottford
Copy link
Contributor Author

In response to the DCO failure, I'll be signing all of my commits and doing a force push after that's done.

@stevespringett
Copy link
Member

Big thanks for the PR. I had to update the GitHub actions that were used. The ones specified were deprecated and no longer supported. Could you sync your fork to master? I'd like to get a passing build before merge.

@mscottford mscottford force-pushed the add-acceptance-and-unit-testing branch from 8e27d3d to 9a22bb0 Compare April 5, 2023 18:23
mscottford added 24 commits April 5, 2023 14:23
@mscottford
Ignores lock file
422e032 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Rename bin directory to exe
66991c5 
This better conforms to the structure that's generated by running the `bundle gem` command.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Uses git to determine files, excludes tests, and correctly sets the `…
0d0cb40 
…bindir`

This better conforms to the structure that's generated when `bundle gem` is run.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds cucumber and aruba for writing tests against the executable
6406c7f 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds missing dependency for activesupport
0b6a0b7 
`bom_builder.rb` is requiring `active_support/core_ext/hash` but `activesupport` wasn't listed in the `.gemspec` as a dependency. This likely hasn't come up before because consumers have had `activesupport` listed as dependency.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds coverage for the --help parameter
6a41f8e 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Only ignores Gemfile.lock when it appears in the root
c5008cb 
This avoids issues with `Gemfile.lock` files being used with fixtures.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds a simple fixture to assist with testing
d8a609e 
This `Gemfile` and `Gemfile.lock` only references `activesupport`.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Silences cucumber publish message
9af170e 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds expected xml bom to fixture
1ed5510 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds coverage for using --path with default options
4836115 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Removes -h scenario
70b5382 
I'm not sure that acceptance tests for the short parameters makes sense. I think a unit test would be a better way to go about handling that.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Ignores temp location used by aruba
22a500b 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds feature for specifying --format xml
baf50d9 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Correctly formats serialNumber after replacement
d5b770b 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds expected Json BOM to fixture
a4703d7 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds feature for Json format
207dd44 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds coverage for specifying the output path
313ef44 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds simplecov and configures it to collect coverage from cucumber
617f1bd 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds a test for the purl helper method
eaf308c 
This was mainly done to make sure the `simplecov` configuration was working correctly.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Ensure that coverage dir is removed before running test suite
b4365fb 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Adds coverage for --verbose
9b23376 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Fixes typo in Json comparison step
1fae41b 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Increases coverage for BomComponent class
aae1fec 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford mscottford force-pushed the add-acceptance-and-unit-testing branch from 9a22bb0 to aae1fec Compare April 5, 2023 18:23
@mscottford
Copy link
Contributor Author

Big thanks for the PR. I had to update the GitHub actions that were used. The ones specified were deprecated and no longer supported. Could you sync your fork to master? I'd like to get a passing build before merge.

Not a problem! I've rebased off of master and I've signed my commits.

@mscottford
Copy link
Contributor Author

I see that CI is still failing. I'm going to work on getting that to pass. I'm going to add a matrix of ruby versions to test against.

@mscottford
Adds a matrix of ruby versions to run tests against
c6f82df 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Removes ruby 2.6
8b4dea7 
`activesupport` version 7.x does not support Ruby versions
older than 2.7.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Copy link
Contributor Author

I see that CI is still failing. I'm going to work on getting that to pass. I'm going to add a matrix of ruby versions to test against.

CI appears to have been failing because activesupport version 7.x does not support Ruby versions older than 2.7, so I removed Ruby 2.6 from the support matrix. If Ruby 2.6 needs to be supported, then we'll need to depend on an older version of activesupport.

@mscottford
Removes comment that was used during development
40a61d9 
Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Specifies rubocop target version
f510a03 
Sonatype Lift is using Rubocop to report quality violations.
The default configuration Sonatype Lift is using is not
publically available. So in order to fix the comment that it
left on the pull request after the version requirement was
added to the `.gemspec` file, I added Rubocop as a development
dependency, and then generated a TODO style configuration that
excludes all of the default warnings except for the one that
Sonatype Lift reported. That one was fixed.

Signed-off-by: M. Scott Ford <[email protected]>
@mscottford
Copy link
Contributor Author

Yay! That's a passing build, @stevespringett. Please let me know if you have any code review feedback.

@stevespringett
Copy link
Member

Fantastic. Thanks so much for the PR.

@stevespringett stevespringett merged commit dd3f29e into CycloneDX:master Apr 6, 2023
@mscottford mscottford deleted the add-acceptance-and-unit-testing branch April 6, 2023 14:14
@mscottford mscottford mentioned this pull request Apr 7, 2023
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sonatype-lift sonatype-lift[bot] sonatype-lift[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mscottford @stevespringett