feat: Added unit tests.

Author: jamesiarmes

.github/workflows/ruby.yaml

@@ -61,3 +61,19 @@ jobs:
       - name: RuboCop Linter
         working-directory: ${{ matrix.dir }}
         run: bundle exec rubocop
+
+  spec:
+    runs-on: ubuntu-latest
+    env:
+      COVERAGE: 1
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          working-directory: ${{ matrix.dir }}
+      - name: Run tests
+        working-directory: ${{ matrix.dir }}
+        run: bundle exec rspec

hyperproof/.gitignore

@@ -1,3 +1,4 @@
 *.csv
 *.env
+coverage/
 vendor/

hyperproof/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper.rb
+--color
+--format RSpec::Github::Formatter
+--format documentation

hyperproof/.rubocop.yml

@@ -1,6 +1,7 @@
 plugins:
   - rubocop-performance
   - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   NewCops: enable
@@ -10,11 +11,21 @@ AllCops:
 Metrics/MethodLength:
   CountAsOne:
     - array
-    - method_call
     - hash
+    - method_call
 
 # Exclude our main gem include from the file naming convention, to keep it
 # consistent with the gem name.
 Naming/FileName:
   Exclude:
     - 'lib/cfa-security-controls-hyperproof.rb'
+
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - method_call
+
+# Favor more reusable helpers.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

hyperproof/Gemfile

@@ -9,4 +9,12 @@ group :development do
   gem 'rubocop', '~> 1.75'
   gem 'rubocop-performance', '~> 1.25'
   gem 'rubocop-rake', '~> 0.7'
+  gem 'rubocop-rspec', '~> 3.6'
+  gem 'rubocop-yard', '~> 0.10'
+end
+
+group :development, :test do
+  gem 'rspec', '~> 3.13'
+  gem 'rspec-github', '~> 3.0'
+  gem 'simplecov', '~> 0.22'
 end

hyperproof/Gemfile.lock

@@ -74,6 +74,8 @@ GEM
     concurrent-ruby (1.3.4)
     connection_pool (2.5.3)
     csv (3.3.4)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
     drb (2.2.1)
     faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
@@ -124,6 +126,21 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-github (3.0.0)
+      rspec-core (~> 3.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
     rubocop (1.75.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -145,8 +162,20 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-yard (0.10.0)
+      rubocop (~> 1.21)
+      yard
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
@@ -159,6 +188,7 @@ GEM
     uri (1.0.3)
     uri_template (0.7.0)
     version_gem (1.1.8)
+    yard (0.9.37)
 
 PLATFORMS
   arm64-darwin-24
@@ -167,9 +197,14 @@ PLATFORMS
 DEPENDENCIES
   cfa-security-controls-hyperproof!
   rake (~> 13.2)
+  rspec (~> 3.13)
+  rspec-github (~> 3.0)
   rubocop (~> 1.75)
   rubocop-performance (~> 1.25)
   rubocop-rake (~> 0.7)
+  rubocop-rspec (~> 3.6)
+  rubocop-yard (~> 0.10)
+  simplecov (~> 0.22)
 
 BUNDLED WITH
    2.6.7

hyperproof/README.md

@@ -0,0 +1,52 @@
+# Hyperproof
+
+This is a system to collect evidence (proofs) of our security and compliance
+posture, and sync them with our compliance management system ([Hyperproof]).
+
+## Usage
+
+You can run the system from GitHub Actions (recommended), or locally.
+
+### GitHub Actions
+
+Run the [Hyperproof Sync][workflow] from the GitHub Actions tab of this
+repository. Alternatively, if you have the [GitHub CLI][gh] installed, you can
+run the workflow from the command line:
+
+```bash
+gh workflow run hyperproof.yaml
+```
+
+### Locally
+
+If you want to run the system locally — to test changes or debug issues, for
+example — you will first need to install the necessary dependencies. Use your
+favorite ruby version manager to install the required [version of
+ruby][ruby-version].
+
+Make sure you've switched to the `hyperproof` directory in the repository, then
+install the dependencies using `bundler`:
+
+```bash
+cd hyperproof
+bundle install
+```
+
+You should now be able to run use the provided CLI command. You can check the
+current version to verify that everything is working:
+
+```bash
+./bin/hyperproof version
+```
+
+If you see the version number, you're good to go! You can now run the full
+system with:
+
+```bash
+./bin/hyperproof collect
+```
+
+[gh]: https://cli.github.com/
+[hyperproof]: https://hyperproof.io/
+[ruby-version]: https://github.com/codeforamerica/cfa-security-controls/tree/main/hyperproof/.ruby-version
+[workflow]: https://github.com/codeforamerica/cfa-security-controls/actions/workflows/hyperproof.yaml

hyperproof/Rakefile

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 require 'bundler'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-task default: %i[rubocop]
+task default: %i[rubocop spec]
 
 Bundler::GemHelper.install_tasks
 
+RSpec::Core::RakeTask.new(:spec)
+
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.requires << 'rubocop'
+  task.formatters = %w[pacman]
+  task.formatters << 'github' if ENV.fetch('GITHUB_ACTIONS', false)
 end

hyperproof/lib/cfa_security_controls/hyperproof.rb

@@ -7,14 +7,6 @@
 module CfaSecurityControls
   # Top level module for our gem.
   module Hyperproof
-    # Collect all proofs without writing them to Hyperproof.
-    def self.collect
-      Proofs.proofs.map do |collector|
-        r = collector.new.collect
-        pp(r)
-      end
-    end
-
     # Collect and upload all proofs to Hyperproof.
     def self.run
       Dir.mktmpdir do |dir|

hyperproof/lib/cfa_security_controls/hyperproof/clients/aptible.rb

@@ -38,6 +38,8 @@ def token
           @token ||= basic_auth_token || sso_token
 
           raise InvalidCredentials, 'No valid Aptible credentials found' unless @token
+
+          @token
         end
 
         # Retrieve the SSO token from the Aptible token file.