rspec_oscal_formatter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b142acb0a975b36fa4bd8dc44d80c1c6bb8795c142938dff273d6e9dcd76fac2
+  data.tar.gz: a54f50d499b2048c20a37e8ce72c7f2b88874d392629bda8cdfe0e260c5796a6
+SHA512:
+  metadata.gz: a068241fbe38583fae4483140bf5a044959ec198435461ddd4a29e49ef7f0fd7202753ea21c743479c0d3dba9f02a151a7da0abbe84fbbe544950d4b78f5ed4f
+  data.tar.gz: 0c35353fb3b4f817e309b5bb4d7a29aa9d993b344abcc40be53e31f961f7cfc16d95fd3cc823d2ae6417706ac29fe93eb045761d3f36bba757cc823b57a5a058

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-29
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Credentive
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# RSpecOscalFormatter
+
+This Library provides an RSpec Formatter that helps you to define tests that align with OSCAL Catalogs and SSPs, and produce Assessment Plan and Assessment Result documents based on the test results.
+
+## Installation
+
+Note that this library currently depends on a (temporary) fork of oscal-ruby that includes the artifacts we are interested. We hope to coordinate with that team to merge the codebase and move on to other projects.
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+PLEASE SEE A [DEMO SPEC HERE](https://github.com/Credentive-Sec/rspec_oscal_formatter/blob/main/spec/demo_specs/demo_spec.rb) THAT GIVES AN OVERVIEW OF THE METADATA REQUIRED TO MAKE THIS WORK.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Credentive-Sec/rspec_oscal_formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rspec_oscal_formatter/create_assessment_plan.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'oscal'
+
+module RSpec
+  module RSpecOscalFormatter
+    # Create an assessment plan from the metadata and template
+    class CreateAssessmentPlan
+      def initialize(metadata)
+        @assessment_plan =
+          Oscal::AssessmentPlan::AssessmentPlan.new(
+            {
+              uuid: metadata.assessment_plan_uuid,
+              metadata: build_ap_metadata_block(metadata),
+              import_ssp: { href: './assessment_plan.json' },
+              reviewed_controls: make_reviewed_controls(metadata),
+            },
+          )
+      end
+
+      def build_ap_metadata_block(metadata)
+        {
+          title: "Automated Testing Plan for login.gov. It #{metadata.description}",
+          last_modified: DateTime.now.iso8601,
+          version: DateTime.now.iso8601,
+          oscal_version: '1.1.2',
+        }
+      end
+
+      def make_reviewed_controls(metadata)
+        {
+          control_selections: [
+            include_controls: [
+              {
+                control_id: metadata.control_id,
+                statement_ids: [metadata.statement_id],
+              },
+            ],
+          ],
+        }
+      end
+
+      def get
+        @assessment_plan
+      end
+
+      def to_json(*_args)
+        @assessment_plan.to_json
+      end
+    end
+  end
+end

data/lib/rspec_oscal_formatter/create_assessment_results.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'random/formatter'
+
+require 'oscal'
+
+module RSpec
+  module RSpecOscalFormatter
+    # Creates an Assessment Result from an RSpec Unit Test Run
+    class CreateAssessmentResult
+      def initialize(metadata)
+        @assessment_result = Oscal::AssessmentResult::AssessmentResult.new(
+          uuid: Random.uuid,
+          metadata: build_metadata_block,
+          import_ap: { href: './exported_ap.json' }, # This is not correct. Should be dynamic.
+          results: create_results_block(metadata),
+        )
+      end
+
+      def build_metadata_block
+        {
+          title: 'Test Result for login.gov.',
+          last_modified: DateTime.now.iso8601,
+          version: DateTime.now.iso8601,
+          oscal_version: '1.1.2',
+        }
+      end
+
+      def create_results_block(metadata)
+        # TODO: - multiple results per test?
+        [{
+          uuid: Random.uuid,
+          title: metadata.description,
+          description: metadata.description,
+          start: DateTime.now.iso8601,
+          reviewed_controls: create_reviewed_controls(metadata),
+          observations: [create_observations(metadata)],
+          findings: [create_findings(metadata)],
+        }]
+      end
+
+      def create_reviewed_controls(metadata)
+        {
+          control_selections: [
+            {
+              include_controls: [
+                { control_id: metadata.control_id },
+              ],
+            },
+          ],
+        }
+      end
+
+      def create_observations(metadata)
+        {
+          uuid: Random.uuid,
+          title: metadata.description,
+          description: metadata.description,
+          methods: ['TEST'],
+          collected: DateTime.now.iso8601,
+        }
+      end
+
+      def create_findings(metadata)
+        {
+          uuid: Random.uuid,
+          title: 'Automated Test Outcome',
+          description: metadata.description,
+          target: create_target(metadata),
+        }
+      end
+
+      def create_target(metadata)
+        {
+          type: 'statement-id',
+          target_id: metadata.statement_id,
+          status: {
+            state: metadata.state,
+            reason: metadata.reason,
+          },
+        }
+      end
+
+      def get
+        @assessment_result
+      end
+
+      def to_json(*_args)
+        @assessment_result.to_json
+      end
+    end
+  end
+end

data/lib/rspec_oscal_formatter/parse_spec_metadata.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RSpec
+  module RSpecOscalFormatter
+    # Tiny helper class to provide easy access to the metadata attributes in the spec.
+    class SpecMetaDataParser
+      STATUS_MAP = {
+        passed: 'pass',
+        failed: 'fail',
+        pending: 'other',
+      }
+
+      attr_reader(
+        *(METADATA = %i[assessment_plan_uuid control_id description statement_id ssp_url reason
+                        state].freeze),
+      )
+
+      def validate_contents(metadata)
+        # Make sure required attributes are present
+        METADATA.each do |attribute|
+          raise IndexError if attribute.nil?
+        end
+      end
+
+      def initialize(example)
+        validate_contents(example.metadata) # TODO: - figure out a way to dump out if metadata isn't complete
+        @output_directory = example.metadata[:output_directory]
+        @assessment_plan_uuid = example.metadata[:assessment_plan_uuid]
+        @control_id = example.metadata[:control_id]
+        @description = example.metadata[:description]
+        @statement_id = example.metadata[:statement_id]
+        @reason = STATUS_MAP[example.execution_result.status]
+        @state = @reason == 'pass' ? 'satisfied' : 'not-satisfied'
+      end
+    end
+  end
+end

data/lib/rspec_oscal_formatter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RSpecOscalFormatter
+  VERSION = '0.1.1'
+end

data/lib/rspec_oscal_formatter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'date'
+require 'pathname'
+
+Dir[File.join(__dir__, "rspec_oscal_formatter", "*.rb")].each { |file| require file }
+
+# To format the output of Rspec tests as OSCAL Assessment Plans and Assessment Results
+module RSpec
+  module RSpecOscalFormatter
+    class Error < StandardError; end
+
+    # Core class for the formatter
+    class Formatter
+      RSpec::Core::Formatters.register self, :example_finished
+
+      OUTPUT_DIRECTORY = Pathname.new('/tmp/oscal_outputs').freeze # TODO: should be a property
+
+      def initialize(output)
+        @output = output
+      end
+
+      # Generate a timestamped directory to save the file
+      def create_output_directory
+        example_out_dir = OUTPUT_DIRECTORY.join(DateTime.now.iso8601)
+        # We should raise an exception here if we can't create the directory
+        example_out_dir.mkpath unless example_out_dir.exist? && example_out_dir.directory?
+        example_out_dir
+      end
+
+      def example_finished(notification)
+        metadata = SpecMetaDataParser.new(notification.example)
+
+        out_dir = create_output_directory
+
+        out_dir.join("#{metadata.control_id}-assessment-plan.json").open('w').write(
+          CreateAssessmentPlan.new(metadata).to_json,
+        )
+
+        out_dir.join("#{metadata.control_id}-assessment-result.json").open('w').write(
+          CreateAssessmentResult.new(metadata).to_json,
+        )
+      end
+    end
+  end
+end

data/sig/rspec_oscal_formatter.rbs

@@ -0,0 +1,4 @@
+module RSpecOscalFormatter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test.rb

@@ -0,0 +1,8 @@
+class TestAttr
+  attr_reader :test1, :test2
+
+  def initialize
+    @test1 = '1'
+    @test2 = '2'
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rspec_oscal_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Robert Sherwood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oscal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: 
+email:
+- robert.sherwood@credentive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec_oscal_formatter.rb
+- lib/rspec_oscal_formatter/create_assessment_plan.rb
+- lib/rspec_oscal_formatter/create_assessment_results.rb
+- lib/rspec_oscal_formatter/parse_spec_metadata.rb
+- lib/rspec_oscal_formatter/version.rb
+- sig/rspec_oscal_formatter.rbs
+- test.rb
+homepage: https://github.com/Credentive-Sec/rspec_oscal_formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Credentive-Sec/rspec_oscal_formatter
+  source_code_uri: https://github.com/Credentive-Sec/rspec_oscal_formatter
+  changelog_uri: https://github.com/Credentive-Sec/rspec_oscal_formatter/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: An RSpec formatter that allows you to write security focused tests for OSCAL
+  catalogs and produce Assessment Plans and Assessment Results.
+test_files: []