opencontrol-linter 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5809df9b521e096796e994cacf885be8dd2d41b
-  data.tar.gz: 4b1b9250c44fbc75d3a2b941003de47a5f0def13
+  metadata.gz: 3b1773ccc2811449ec1301e04c94fe2a565c9566
+  data.tar.gz: 9886d0f7407336e7b778782f6caa54cfca8f8f63
 SHA512:
-  metadata.gz: 27353289411c6cf7bd42794274c6a134a89c51b3cf7555c6bafc047ec2bbfce4b743760c4719a58451f2e9d3b9c8495437e609c6687c41bef4448b91928f57ba
-  data.tar.gz: 722a2e65f5f4c6aaa2a8d7806f34669513e195cde7fd654927d3dd514427c0d88286de961abbbd73ac7813f29ea380136ca19796687601ca701fd3ada2fb1d4d
+  metadata.gz: e96a86d1ab99fefc892834c2308963df602b03629e269dc5a02b1d103bf5b7347ed0e4e482e62d863f7ef7d14526629ea6fb8dcc46743013972272dbb6126b0c
+  data.tar.gz: 433cc89a8ce6051507c4beae1f7aaa4769d3ae24c497a6118f0f035acdf43d9f4411eb759bbc651415c18ade1ff89ed2bda7e67a58c14018ef9fbf38218b915d

data/README.md

@@ -73,6 +73,54 @@ opencontrol-linter --components './components/AU_policy/component.yaml'
 
 ```
 
+## Search Paths
+
+By default the linter will search in the following paths. 
+
+These paths can all be overridden on the command line.
+```
+components:        '**/component.yaml'       (recursive search for files named component)
+standards:         './standards/*.yaml'
+certifications:    './certifications/*.yaml'
+opencontrol files: './opencontrol.yaml'
+
+```
+
+The following directory structure for compliance is typical. You can specify those that match your project.
+```
+Project Root
+.
+└── compliance
+    ├── opencontrol.yaml
+    ├── certifications
+    │   └── FredRAMP-high.yaml
+    ├── components
+    │   ├── AU_policy
+    │   │   └── component.yaml
+    │   └── AWS_core
+    │       └── component.yaml
+    └── standards
+        └── FRIST-800-53.yaml
+
+```
+
+## Development
+
+Clone this repo
+```
+git clone https://github.com/adriankierman/opencontrol-linter.git
+
+```
+Install Dependencies
+```
+bundle install
+```
+
+To run tests:
+```
+rake spec
+```
+
 ## Compatibility
 
 Open Control Linter supports the following Open Control schemas:

data/lib/opencontrol.rb

@@ -1,3 +1,4 @@
 require_relative 'opencontrol/version'
 require_relative 'opencontrol/messages'
 require_relative 'opencontrol/cli'
+require_relative 'opencontrol/linter'

data/lib/opencontrol/cli.rb

@@ -1,4 +1,3 @@
-require 'kwalify'
 require 'yaml'
 require 'opencontrol'
 require 'rationalist'
@@ -28,6 +27,10 @@ module Opencontrol
                               Specify standard files (eg NIST 800.53) should be
                               checked. Defaults to true. Searches ./standards/*.yaml
                               or the search you optionally specify.
+        -o, --opencontrols, --opencontrol
+                              Specify opencontrol file or files should be
+                              checked. Defaults to true. Searches ./opencontrol.yaml
+                              or the search you optionally specify.
         -a, --all             Run all types of validations (this is the default).
         -v, --version         Show the version of this utility.
 
@@ -51,7 +54,7 @@ USAGE_TEXT
       targets: [
         {
           type: :components,
-          pattern: '**/component.yaml'
+          pattern: './components/**/component.yaml'
         },
         {
           type: :standards,
@@ -60,10 +63,24 @@ USAGE_TEXT
         {
           type: :certifications,
           pattern: './certifications/*.yaml'
+        },
+        {
+            type: :opencontrols,
+            pattern: './opencontrol.yaml'
         }
       ]
     }.freeze
 
+    ALIASES = {
+        components: %w[component c],
+        standards: %w[standard s],
+        certifications: %w[certification n],
+        opencontrols: %w[opencontrol o],
+        all: 'a',
+        help: 'h',
+        version: 'v'
+    }.freeze
+
     def self.show_help
       puts USAGE_TEXT
       0 # exit with no error
@@ -75,46 +92,6 @@ USAGE_TEXT
       0 # exit with no error
     end
 
-    # @param [String] version
-    def self.find_schema(type, version)
-      dir = __dir__
-      case type
-      when :components
-        "#{dir}/../../vendor/schemas/kwalify/component/v#{version}.yaml"
-      when :standards
-        "#{dir}/../../vendor/schemas/kwalify/standard/v#{version}.yaml"
-      when :certifications
-        "#{dir}/../../vendor/schemas/kwalify/certification/v#{version}.yaml"
-      else
-        throw "Unknown type of schema specified #{type} " \
-    "tried to get schema version #{version}"
-      end
-    end
-
-    def self.load_schema(schema_file)
-      ## load schema data
-      # Kwalify::Yaml.load_file(schema_file)
-      ## or
-      YAML.load_file(schema_file)
-    end
-
-    def self.show_issues(issues, filename)
-      if issues && !issues.empty?
-        puts "✗ #{filename}".red
-        issues.each do |issue|
-          puts Opencontrol::Messages.detail(issue).yellow
-        end
-      else
-        puts "✓ #{filename}".green
-      end
-    end
-
-    def self.schema_for_document(type, document)
-      version = document['schema_version'] || '1.0.0'
-      schema_file = find_schema(type, version)
-      load_schema(schema_file)
-    end
-
     def self.targets_for_type(type, specification)
       specification[:targets].select { |t| t[:type] == type }
     end
@@ -133,48 +110,6 @@ USAGE_TEXT
       )
     end
 
-    def self.validate(type, filename)
-      ## load document
-      # document = Kwalify::Yaml.load_file(filename)
-      ## or
-      document = YAML.load_file(filename)
-      schema = schema_for_document(type, document)
-
-      validator = Kwalify::Validator.new(schema)
-      validator.validate(document)
-    end
-
-    def self.files_not_found_issue
-      Kwalify::BaseError.new(
-        'No validation files found for the pattern supplied. \
-         Adding an issue to avoid failing silently.',
-        nil,
-        nil,
-        nil,
-        :linter_files_not_found_issue
-      )
-    end
-
-    def self.validate_target(target)
-      filenames = Dir[target[:pattern]]
-      if filenames.empty?
-        issues = [files_not_found_issue]
-        show_issues(issues, target[:pattern])
-        return issues
-      end
-      filenames.collect do |filename|
-        issues = validate(target[:type], filename)
-        show_issues(issues, filename)
-        issues
-      end
-    end
-
-    def self.validate_all(specification)
-      specification[:targets].collect do |target|
-        validate_target(target)
-      end.flatten
-    end
-
     def self.should_lint?(opts)
       !(opts[:version] || opts[:help])
     end
@@ -187,15 +122,6 @@ USAGE_TEXT
       all_targets_selected?(opts, specification) && should_lint?(opts)
     end
 
-    ALIASES = {
-      components: %w[component c],
-      standards: %w[standard s],
-      certifications: %w[certification n],
-      all: 'a',
-      help: 'h',
-      version: 'v'
-    }.freeze
-
     def self.parse_args(arguments)
       opts = Rationalist.parse(arguments, alias: ALIASES)
       specification = {
@@ -207,25 +133,16 @@ USAGE_TEXT
       add_target(:components, opts, specification)     if opts[:components]
       add_target(:standards, opts, specification)      if opts[:standards]
       add_target(:certifications, opts, specification) if opts[:certifications]
+      add_target(:opencontrols, opts, specification)   if opts[:opencontrols]
       specification = DEFAULT_SPECIFICATION if use_default?(opts, specification)
       specification
     end
 
-    def self.run(specification)
-      issues = validate_all(specification)
-      if !issues.empty?
-        puts "Complete. #{issues.length} issues found.".red
-      else
-        puts 'Complete. No problems found.'.green
-      end
-      issues.length
-    end
-
     def self.run_with_args(args)
       specification = parse_args(args)
-      exit(run(specification)) if specification[:action] == :run
-      show_version             if specification[:action] == :version
-      show_help                if specification[:action] == :help
+      exit(Opencontrol::Linter.run(specification)) if specification[:action] == :run
+      show_version                                 if specification[:action] == :version
+      show_help                                    if specification[:action] == :help
     end
   end
 end

data/lib/opencontrol/linter.rb

@@ -0,0 +1,115 @@
+require 'kwalify'
+require 'yaml'
+require 'opencontrol'
+require 'colorize'
+require 'pp'
+
+# frozen_string_literal: true
+
+module Opencontrol
+  # This module holds the Opencontrol Linter Command Line Interface.
+  module Linter
+
+    # @param [String] version
+    def self.find_schema(type, version)
+      dir = __dir__
+      case type
+      when :components
+        "#{dir}/../../vendor/schemas/kwalify/component/v#{version}.yaml"
+      when :standards
+        "#{dir}/../../vendor/schemas/kwalify/standard/v#{version}.yaml"
+      when :certifications
+        "#{dir}/../../vendor/schemas/kwalify/certification/v#{version}.yaml"
+      when :opencontrols
+        "#{dir}/../../vendor/schemas/kwalify/opencontrol/v#{version}.yaml"
+      else
+        throw "Unknown type of schema specified #{type} " \
+    "tried to get schema version #{version}"
+      end
+    end
+
+    def self.load_schema(schema_file)
+      ## load schema data
+      # Kwalify::Yaml.load_file(schema_file)
+      ## or
+      YAML.load_file(schema_file)
+    end
+
+    def self.show_issues(issues, filename)
+      if issues && !issues.empty?
+        puts "✗ #{filename}".red
+        issues.each do |issue|
+          puts Opencontrol::Messages.detail(issue).yellow
+        end
+      else
+        puts "✓ #{filename}".green
+      end
+    end
+
+    def self.schema_for_document(type, document)
+      version = document['schema_version'] || '1.0.0'
+      schema_file = find_schema(type, version)
+      load_schema(schema_file)
+    end
+
+    def self.targets_for_type(type, specification)
+      specification[:targets].select { |t| t[:type] == type }
+    end
+
+    def self.default_pattern_for_type(type)
+      targets_for_type(type, DEFAULT_SPECIFICATION).first[:pattern]
+    end
+
+    def self.validate(type, filename)
+      ## load document
+      # document = Kwalify::Yaml.load_file(filename)
+      ## or
+      document = YAML.load_file(filename)
+      schema = schema_for_document(type, document)
+
+      validator = Kwalify::Validator.new(schema)
+      validator.validate(document)
+    end
+
+    def self.files_not_found_issue
+      Kwalify::BaseError.new(
+          'No validation files found for the pattern supplied. \
+         Adding an issue to avoid failing silently.',
+          nil,
+          nil,
+          nil,
+          :linter_files_not_found_issue
+      )
+    end
+
+    def self.validate_target(target)
+      filenames = Dir[target[:pattern]]
+      if filenames.empty?
+        issues = [files_not_found_issue]
+        show_issues(issues, target[:pattern])
+        return issues
+      end
+      filenames.collect do |filename|
+        issues = validate(target[:type], filename)
+        show_issues(issues, filename)
+        issues
+      end
+    end
+
+    def self.validate_all(specification)
+      specification[:targets].collect do |target|
+        validate_target(target)
+      end.flatten
+    end
+
+    def self.run(specification)
+      issues = validate_all(specification)
+      if !issues.empty?
+        puts "Complete. #{issues.length} issues found.".red
+      else
+        puts 'Complete. No problems found.'.green
+      end
+      issues.length
+    end
+  end
+end

data/lib/opencontrol/version.rb

@@ -3,7 +3,7 @@
 module Opencontrol
   # This module holds the Opencontrol Linter version information.
   module Version
-    STRING = '0.1'.freeze
+    STRING = '0.1.1'.freeze
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
           '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'.freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opencontrol-linter
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Adrian Kierman
@@ -263,6 +263,7 @@ files:
 - exe/opencontrol-linter
 - lib/opencontrol.rb
 - lib/opencontrol/cli.rb
+- lib/opencontrol/linter.rb
 - lib/opencontrol/messages.rb
 - lib/opencontrol/version.rb
 - vendor/README.md