octool 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03d4e6cdc68059584e26dd26983e2085aed2bb5593b1bb78d5307bc9938401d7
-  data.tar.gz: 15f8bf0c448fb1e1091f7e6ab78fbffba50925a2a7799dd66ff939674d135cea
+  metadata.gz: 245e14c9cf523957cca7c2826364125a1f11715a080015124c9477b1c99c6707
+  data.tar.gz: '0759efbc98a8ce26407649d2c4c458e273d3711c8661fbc94b6bb13e194a9695'
 SHA512:
-  metadata.gz: a944191a813ab2ed2d122862466d79e65df9230e64ade9e73b83aefb8fcb98069bfaba0fec0876c539f63b7f229a16311b0721bd81eeb17b49b7564da2995051
-  data.tar.gz: e3b99bc6618b4192ba99a570bf6dd6a364c52540b73b39d80817a43e7364fdaf730596578756149e60cda5c0e56d3e75f643abdb11838a983f1d8943df9f0712
+  metadata.gz: a27114864b9430e4096429a2d26d13d92ed6bc53ebfb9fa00008e1beb04cc8527f0637d336020826172b47109b192a94b9adfb6eef3036ce160f150be35b6f5d
+  data.tar.gz: 684fca7c472d21356ce73e63d6c079c959108ebd5debfb66b10e35acfdf04a899a50c9d669db938f284963159eaa656b4f3c981e560a17b1e3396ae8a7c99da8

data/bin/octool

@@ -21,7 +21,7 @@ class App
     def self.find_config(args)
         path = args.first || OCTool::DEFAULT_CONFIG_FILENAME
         path = File.join(path, OCTool::DEFAULT_CONFIG_FILENAME) if File.directory?(path)
-        path
+        File.expand_path(path)
     end
 
     program_desc 'Open Compliance Tool'
@@ -51,6 +51,23 @@ class App
         v.default_command :data
     end
 
+    desc 'export data to CSV'
+    arg_name 'path/to/system/config.yaml'
+    command :csv do |csv|
+        csv.desc 'where to store outputs'
+        csv.default_value data_dir
+        csv.long_desc 'Default output directory respects env vars TMPDIR, TMP, TEMP'
+        csv.arg_name 'path/to/output/dir'
+        csv.flag [:d, :dir]
+
+        csv.action do |global_options, options, args|
+            export_dir = options[:dir]
+            config_file = find_config(args)
+            system = OCTool::Parser.new(config_file).load_system
+            system.dump export_dir
+        end
+    end
+
     desc 'validate data and generate System Security Plan'
     arg_name 'path/to/system/config.yaml'
     command :ssp do |s|
@@ -92,12 +109,12 @@ class App
         # Error logic here
         # Return false to skip default error handling.
         if ENV['DEBUG']
-            STDERR.puts exception.message
-            STDERR.puts exception.backtrace
+            warn exception.message
+            warn exception.backtrace
             pp exception
             false
         end
-        STDERR.puts '[FAIL]'
+        warn '[FAIL]'
         true
     end
 end

data/lib/octool/parser.rb

@@ -4,6 +4,7 @@ module OCTool
     # Custom error to show validation errors.
     class ValidationError < StandardError
         attr_reader :errors
+
         def initialize(path, errors)
             @path = path
             @errors = errors
@@ -40,10 +41,9 @@ module OCTool
         end
 
         def validate_file(path, type)
-            parser = kwalify_parser(type)
-            data = parser.parse_file(path)
-            data['type'] = type
-            errors = parser.errors
+            kwal = kwalifyer(type)
+            data = kwal.parse_file(path)
+            errors = kwal.errors
             raise ValidationError.new(path, errors) unless errors.empty?
 
             RecursiveOpenStruct.new(data, recurse_over_arrays: true, preserve_original_keys: true)
@@ -51,7 +51,7 @@ module OCTool
             die e.message
         end
 
-        def kwalify_parser(type)
+        def kwalifyer(type)
             schema_file = File.join(schema_dir, "#{type}.yaml")
             schema = Kwalify::Yaml.load_file(schema_file)
             validator = Kwalify::Validator.new(schema)
@@ -65,7 +65,7 @@ module OCTool
         def schema_version
             @schema_version ||= Kwalify::Yaml.load_file(@config_file)['schema_version']
         rescue StandarError
-            STDERR.puts '[FAIL] Unable to read schema_version'
+            warn '[FAIL] Unable to read schema_version'
             exit(1)
         end
 
@@ -76,11 +76,45 @@ module OCTool
             sys = System.new(config)
             config['includes'].each do |inc|
                 path = File.join(base_dir, inc['path'])
-                sys.data << validate_file(path, inc['type'])
+                sys.data << include_data(path, inc['type'])
             end
             sys
         end
 
+        def include_data(path, type)
+            data = validate_file(path, type)
+            data['type'] = type
+            method("parsed_#{type}".to_sym).call(data)
+        end
+
+        def parsed_component(component)
+            component.attestations.map! do |a|
+                # Add a "component_key" field to each attestation.
+                a['component_key'] = component.component_key
+                a.satisfies.map! do |s|
+                    # Add "attestation_key" to each control satisfied by this attestation.
+                    s['attestation_key'] = a.summary
+                    # Add "component_key" to each control satisfied by this attestation.
+                    s['component_key'] = component.component_key
+                    s
+                end
+                a
+            end
+            component
+        end
+
+        def parsed_standard(standard)
+            # Add 'standard_key' to each control family and to each control.
+            standard.families.map! { |f| f['standard_key'] = standard.standard_key; f }
+            standard.controls.map! { |c| c['standard_key'] = standard.standard_key; c }
+            standard
+        end
+
+        def parsed_certification(cert)
+            cert.requires.map! { |r| r['certification_key'] = cert.certification_key; r }
+            cert
+        end
+
         alias load_system validate_data
         alias load_file validate_file
     end

data/lib/octool/ssp.rb

@@ -18,13 +18,13 @@ module OCTool
                 Paru::Pandoc.new
             end
         rescue UncaughtThrowError
-            STDERR.puts '[FAIL] octool requires pandoc to generate the SSP. Is pandoc installed?'
+            warn '[FAIL] octool requires pandoc to generate the SSP. Is pandoc installed?'
             exit(1)
         end
 
         def generate
             unless File.writable?(@output_dir)
-                STDERR.puts "[FAIL] #{@output_dir} is not writable"
+                warn "[FAIL] #{@output_dir} is not writable"
                 exit(1)
             end
             render_template

data/lib/octool/system.rb

@@ -6,73 +6,78 @@ module OCTool
         attr_accessor :config
         attr_accessor :data
 
+        TABLE_NAMES = [
+            'components',
+            'satisfies',
+            'attestations',
+            'standards',
+            'controls',
+            'families',
+            'certifications',
+            'requires',
+        ].freeze
+
         def initialize(config)
             @config = config
             @data = []
         end
 
         def certifications
-            @certifications ||= @data.select { |e| e.type == 'certification' }
+            @certifications ||= data.select { |e| e.type == 'certification' }
         end
 
         def components
-            @components ||= @data.select { |e| e.type == 'component' }
+            @components ||= data.select { |e| e.type == 'component' }
         end
 
         def standards
-            @standards ||= @data.select { |e| e.type == 'standard' }
+            @standards ||= data.select { |e| e.type == 'standard' }
         end
 
         # List of all attestations claimed by components in the system.
         def attestations
-            @attestations ||= begin
-                @attestations = []
-                components.each do |c|
-                    # Add a "component_key" field to each attestation.
-                    c.attestations.map! { |e| e['component_key'] = c.component_key; e }
-                    @attestations << c.attestations
-                end
-                @attestations.flatten!
-            end
+            @attestations ||= components.map(&:attestations).flatten
         end
 
         # List of all coverages.
         def satisfies
-            @satisfies ||= begin
-                @satisfies = []
-                attestations.each do |a|
-                    # Add an "attestation_key" field to each cover.
-                    a.satisfies.map! { |e| e['component_key'] = a.commponent_key; e }
-                    a.satisfies.map! { |e| e['attestation_key'] = a.attestation_summary; e }
-                    @satisfies << a.satisfies
-                end
-                @satisfies.flatten!
-            end
+            @satisfies ||= attestations.map(&:satisfies).flatten
         end
 
         # List of all controls defined by standards in the system.
         def controls
-            @controls || begin
-                @controls = []
-                standards.each do |s|
-                    # Add a "standard_key" field to each control.
-                    s.controls.map! { |e| e['standard_key'] = s.standard_key; e }
-                    @controls << s.controls
-                end
-                @controls.flatten!
-            end
+            @controls ||= standards.map(&:controls).flatten
         end
 
         # List of all families defined by standards in the system.
         def families
-            @families || begin
-                @families = []
-                standards.each do |s|
-                    # Add a "standard_key" field to each family.
-                    s.families.map! { |e| e['standard_key'] = s.standard_key; e }
-                    @families << s.families
-                end
-                @families.flatten!
+            @families ||= standards.map(&:families).flatten
+        end
+
+        # List of required controls for all certifications.
+        def requires
+            @requires ||= certifications.map(&:requires).flatten
+        end
+
+        def dump(writable_dir)
+            TABLE_NAMES.each do |type|
+                write_csv method(type.to_sym).call, File.join(writable_dir, "#{type}.csv")
+            end
+        end
+
+        # Convert array of hashes into a CSV.
+        def write_csv(ary, filename)
+            ary = ary.map do |e|
+                # Convert each element from RecursiveOStruct to a Hash.
+                e = e.is_a?(Hash) ? e : e.to_h
+                # Throw away nested hashes.
+                e.reject { |_, val| val.is_a?(Enumerable) }
+            end
+            warn "[INFO] write #{filename}"
+            CSV.open(filename, 'wb') do |csv|
+                column_names = ary.first.keys
+                csv << column_names
+                ary.each { |hash| csv << hash.values_at(*column_names) }
             end
         end
     end

data/lib/octool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OCTool
-    VERSION = '0.0.5'
+    VERSION = '0.0.6'
 end

data/lib/octool.rb

@@ -3,6 +3,7 @@
 require 'octool/version.rb'
 
 # Built-ins.
+require 'csv'
 require 'pp'
 
 # 3rd-party libs.

data/octool.rdoc

@@ -1,6 +1,6 @@
 == octool - Open Compliance Tool
 
-v0.0.5
+v0.0.6
 
 === Global Options
 === --help
@@ -14,6 +14,18 @@ Display the program version
 
 
 === Commands
+==== Command: <tt>csv  path/to/system/config.yaml</tt>
+export data to CSV
+
+
+===== Options
+===== -d|--dir path/to/output/dir
+
+where to store outputs
+
+[Default Value] /tmp
+Default output directory respects env vars TMPDIR, TMP, TEMP
+
 ==== Command: <tt>help  command</tt>
 Shows a list of commands or help for one command
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octool
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Paul Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake