scelint 0.3.0

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+### 0.3.0 / 2025-01-16
+* Use compliance_engine gem for data ingest
+* Check that all fact combinations return hiera data
+* Add `notes` for info-level log items
+* Re-add merged data checks
+* Clean up for release
+
+### 0.2.0 / 2024-10-29
+* Add --strict option to make warnings fatal
+* Warn on legacy facts in confine
+* Make check_confine more strict
+    - Warn if any confine key is another check key (to catch bad indentation in YAML source)
+* Refactor CLI to use thor
+* Add quiet/verbose/debug options to the CLI
+* Bump minimum required Ruby version to 2.7.0 (oldest version we're testing with)
+* Accept 'id' and 'benchmark_version' in profiles
+* Fix accidental merge of nested data
+* Make missing keys an error only on merged data
+* Clarify error messages in `check_settings`
+* Update gem email and homepage for move to SIMP org
+
+### 0.1.0 / 2020-11-12
+* Initial unreleased version

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scelint.gemspec
+gemspec
+
+gem 'rake', '~> 13.2'
+
+group :tests do
+  gem 'rspec', '~> 3.13'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-performance', '~> 1.21'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 3.0'
+end
+
+group :development do
+  gem 'pry', '~> 0.14.1'
+  gem 'pry-byebug', '~> 3.10'
+  gem 'rdoc', '~> 6.4'
+end

data/README.md

@@ -0,0 +1,13 @@
+# `scelint`
+
+Lint SIMP Compliance Engine data.
+
+## Usage
+
+With no arguments, the included `scelint` script will look for SCE data in the standard load path (`SIMP/compliance_profiles`) under the current directory.
+Alternatively, any file arguments specified will be loaded directly.  Any directory arguments will be searched under the standard load path.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/silug/rubygem-simp-scelint.
+

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: [:spec, :rubocop]

data/exe/scelint

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'scelint/cli'
+
+Scelint::CLI.start(['lint'] + ARGV)

data/lib/scelint/cli.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'scelint'
+require 'thor'
+require 'logger'
+
+# SCELint CLI
+class Scelint::CLI < Thor
+  class_option :quiet, type: :boolean, aliases: '-q', default: false
+  class_option :verbose, type: :boolean, aliases: '-v', default: false
+  class_option :debug, type: :boolean, aliases: '-d', default: false
+
+  desc 'lint PATH', 'Lint all files in PATH'
+  option :strict, type: :boolean, aliases: '-s', default: false
+  def lint(*paths)
+    paths = ['.'] if paths.nil? || paths.empty?
+    lint = Scelint::Lint.new(paths, logger: logger)
+
+    count = lint.files.count
+
+    if count.zero?
+      logger.error 'No SCE data found.'
+      exit 0
+    end
+
+    lint.errors.each do |error|
+      logger.error error
+    end
+
+    lint.warnings.each do |warning|
+      logger.warn warning
+    end
+
+    lint.notes.each do |note|
+      logger.info note
+    end
+
+    message = "Checked #{count} files."
+    if lint.errors.count == 0
+      message += '  No errors.'
+      exit_code = 0
+    else
+      message += "  #{lint.errors.count} errors."
+      exit_code = 1
+    end
+
+    if lint.warnings.count > 0
+      message += "  #{lint.warnings.count} warnings."
+      exit_code = 1 if options[:strict]
+    end
+
+    message += " #{lint.notes.count} notes." if lint.notes.count > 0
+
+    logger.info message
+    exit exit_code
+  rescue => e
+    logger.fatal e.message
+  end
+  default_task :lint
+
+  private
+
+  def logger
+    return @logger if @logger
+    @logger = Logger.new(STDOUT)
+    if options[:quiet]
+      @logger.level = Logger::FATAL
+    elsif options[:debug]
+      @logger.level = Logger::DEBUG
+    elsif options[:verbose]
+      @logger.level = Logger::INFO
+    else
+      @logger.level = Logger::INFO
+      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+    end
+    @logger
+  end
+end

data/lib/scelint/version.rb

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