simp-rake-helpers 5.9.1 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a26553d93f116f66c155c12b0f9eb68f09b1e9a2d73b84f6400e6fed5e5035
-  data.tar.gz: 7af4c08f2164fa751aa0d1c22a704ac1f863092e6f609b588eb354f70975919f
+  metadata.gz: 65ee32e179771d6725f18da924bacd3d4b353f3a0c0c749bb2b57a528d90b894
+  data.tar.gz: 045d27ccdf12290434f4204c7d425f15a759728f573f6e86ebe32cf90e5ef5db
 SHA512:
-  metadata.gz: 79b23961c02194be0ca7014096f87f6edbbef853f4e9bc84f25457fb1837d4f3aa0ee90dbf0bc9410a47cebb01a0b340eb741a5643a1e9412fb71671d03aba3b
-  data.tar.gz: 483d7cc338ab38e359c5ca7be792b03c3e50fe7e72f946b65d232475c551bb3666496676179ddb2df38967a9b2cdadca0e2ecf41b453fc84ba080418c7d35c1d
+  metadata.gz: 0b09c3c74733fc251350f2a6e9c09def3847135ecc9343b9ce572b3e85671ceceedade4b401c3545a60ca05cc45ebbc40dfad9d4e97b12b3fcd01139d1b94336
+  data.tar.gz: 76d3d44f17ff155ad8e775722b78c66fa3506024b154d085154744b691bdd2a2088e67f205a079da8e004c97920dd5858dcce588078997460c794f06b4b75ed3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 5.10.0 /2019-08-30
+* Add initial linting tasks for CI configuration (simp:ci_lint and
+  simp:gitlab_ci_lint).  The only checks currently being done are
+  as follows:
+  * verifies the .gitlab-ci.yml is valid YAML
+  * verifies the .gitlab-ci.yml passes GitLab lint checks
+  * verifies each acceptance test job in the .gitlab-ci.yml fully
+    specifies the suite and nodeset to be used and that the specified
+    suite and nodeset exist.
+
 ### 5.9.1 /2019-08-06
 Fixed 2 bugs in the SIMP Puppet module generated RPM spec files
 * When SIMP Puppet module RPMs were installed, they created the wrong

data/lib/simp/ci/gitlab.rb

@@ -0,0 +1,226 @@
+module Simp; end
+module Simp::Ci; end
+
+# Class that provides GitLab-CI-related methods
+class Simp::Ci::Gitlab
+  require 'yaml'
+  require 'json'
+
+  # base class for errors
+  class Error < StandardError ; end
+
+  # incorrectly configured GitLab job
+  class JobError < Error ; end
+
+  # incorrectly configured gitlab-ci.yml
+  class LintError < Error ; end
+
+  # @param component_dir Root directory of the component project
+  def initialize(component_dir)
+    @component_dir = component_dir
+    @gitlab_config_file = File.join(@component_dir, '.gitlab-ci.yml')
+    @gitlab_yaml = nil
+    @acceptance_dir = File.join(@component_dir, 'spec', 'acceptance')
+    @suites_dir = File.join(@acceptance_dir, 'suites')
+
+    # for reporting purposes, just use the name of the component
+    # directory as the component name
+    @component = File.basename(component_dir)
+  end
+
+  # @return true when config is the hash for an acceptance test job
+  def acceptance_job?(config)
+    config.is_a?(Hash) &&
+    config.has_key?('script') &&
+    (config.has_key?('stage') && (config['stage'] == 'acceptance'))
+  end
+
+  # @return whether the project has any suite-based acceptance tests
+  def acceptance_tests?
+    tests_found = false
+    suite_dirs = Dir.glob(File.join(@suites_dir, '*'))
+    suite_dirs.delete_if { |x| ! File.directory?(x) }
+    suite_dirs.each do |suite_dir|
+      tests = Dir.glob(File.join(suite_dir, '*_spec.rb'))
+      next if tests.empty?
+      nodesets = Dir.glob(File.join(suite_dir, 'nodesets', '*.yml'))
+      if nodesets.empty?
+        nodesets = Dir.glob(File.join(@acceptance_dir, 'nodesets', '*.yml'))
+      end
+      unless nodesets.empty?
+        tests_found = true
+        break
+      end
+    end
+    tests_found
+  end
+
+  # @return path to a suite's nodeset YAML file if it exists or nil otherwise
+  #
+  # If the suite has no 'nodesets' directory, it will search for the
+  # nodeset YAML in the global nodeset directory.
+  #
+  def find_nodeset_yaml(suite, nodeset)
+    nodeset_yml = nil
+    suite_nodesets_dir = File.join(@suites_dir, suite, 'nodesets')
+    if Dir.exist?(suite_nodesets_dir)
+      nodeset_yml = File.join(suite_nodesets_dir, "#{nodeset}.yml")
+      nodeset_yml = nil unless File.exist?(nodeset_yml)
+    else
+      nodeset_yml = File.join(@acceptance_dir, 'nodesets', "#{nodeset}.yml")
+      nodeset_yml = nil unless File.exist?(nodeset_yml)
+    end
+    nodeset_yml
+  end
+
+  # Loads .gitlab-ci.yml
+  # @return Hash of GitLab configuration
+  # @raise Simp::Ci::Gitlab::LintError if YAML is malformed
+  def load_gitlab_yaml
+    return @gitlab_yaml if @gitlab_yaml
+
+    begin
+      @gitlab_yaml = YAML.load_file(@gitlab_config_file)
+    rescue Psych::SyntaxError => e
+      msg = "ERROR: Malformed YAML: #{e.message}"
+      raise LintError.new(msg)
+    end
+
+    @gitlab_yaml
+  end
+
+  # Validate GitLab acceptance test job specifications
+  #
+  # Verify each acceptance test job specifies both a valid suite and
+  # a valid nodeset
+  #
+  # @raise Simp::Ci::Gitlab::JobError if validation fails.
+  #   Validation will fail under the following conditions
+  #   (1) an acceptance test job is missing the suite or nodeset
+  #   (2) an acceptance test job contains an invalid suite or nodeset
+  #
+  def validate_acceptance_test_jobs
+    return unless File.exist?(@gitlab_config_file)
+
+    failures = []
+
+    gitlab_yaml = load_gitlab_yaml
+    gitlab_yaml.each do |key, value|
+      next unless acceptance_job?(value)
+
+      value['script'].each do |line|
+        next unless line.include? 'beaker:suites'
+        if line.include?('[')
+          match = line.match(/beaker:suites\[([\w\-_]*)(,([\w\-_]*))?\]/)
+          suite = match[1]
+          nodeset = match[3]
+
+          if ! valid_suite?(suite)
+            failures << "#{@component} job '#{key}' uses invalid suite '#{suite}': '#{line}'"
+          elsif nodeset.nil?
+            failures << "#{@component} job '#{key}' missing nodeset: '#{line}'"
+          elsif ! find_nodeset_yaml(suite, nodeset)
+            failures << "#{@component} job '#{key}' uses invalid nodeset '#{nodeset}': '#{line}'"
+          end
+        else
+          failures <<  "#{@component} job '#{key}' missing suite and nodeset: '#{line}'"
+        end
+      end
+    end
+
+    unless failures.empty?
+      separator = "\n   "
+      msg = "Invalid GitLab acceptance test config:#{separator}#{failures.join(separator)}"
+      raise JobError.new(msg)
+    end
+  end
+
+  # Validate gitlab configuration
+  #
+  # Validation performed
+  # - Verifies configuration file is valid YAML
+  # --Verifies configuration file passes GitLab lint check, when connectivity
+  #   to GitLab is available
+  # - Verifies acceptance test job configuration has valid suites and nodesets
+  # @raise Simp::Ci::Gitlab::Error upon any validation failure
+  #
+  def validate_config
+    if File.exist?(@gitlab_config_file)
+      validate_yaml
+      validate_acceptance_test_jobs
+    elsif acceptance_tests?
+      # can't assume this is a failure, so just warn
+      puts "WARNING:  #{@component} has acceptance tests but no .gitlab-ci.yml"
+    end
+  end
+
+  # Verifies gitlab-ci.yml is valid YAML and, when possible, passes GitLab
+  # lint checks
+  # @raise Simp::Ci::Gitlab::LintError upon any failure
+  def validate_yaml
+    return unless File.exist?(@gitlab_config_file)
+
+    # first check for malformed yaml
+    gitlab_yaml = load_gitlab_yaml
+
+    # apply GitLab lint check
+    begin
+      gitlab_config_json = gitlab_yaml.to_json
+    rescue Exception => e
+      # really should never get here....
+      puts "WARNING: Could not lint check #{@component}'s GitLab configuration: query could not be formed"
+      return
+    end
+
+    curl ||= %x(which curl).strip
+    if curl.empty?
+      puts "WARNING: Could not lint check #{@component}'s GitLab configuration: Could not find 'curl'"
+      return
+    end
+
+    query = [
+      curl,
+      '--silent',
+      '--header "Content-Type: application/json"',
+      'https://gitlab.com/api/v4/ci/lint',
+      '--data', "'{\"content\":#{gitlab_config_json.dump}}'"
+    ]
+    result = `#{query.join(' ')}`
+
+    status = :unknown
+    errors = nil
+    begin
+      result_hash = JSON.load(result)
+      # if stdout is empty, result_hash will be nil
+      unless result_hash.nil?
+        if result_hash.has_key?('status')
+          if result_hash['status'] == 'valid'
+            status = :valid
+          else
+            status = :invalid
+            errors = result_hash['errors']
+          end
+        end
+      end
+
+    rescue
+      # stdout does not contain JSON...don't know what happened!
+    end
+
+    if status == :unknown
+      puts "WARNING: Unable to lint check #{@component}'s GitLab configuration"
+    elsif status == :invalid
+      separator = "\n   "
+      msg = "ERROR: Invalid GitLab config:#{separator}#{errors.join(separator)}"
+      raise LintError.new(msg)
+    end
+  end
+
+
+  def valid_suite?(suite)
+    suite_dir = File.join(@suites_dir, suite)
+    #TODO check for suites that have no tests?
+    return Dir.exist?(suite_dir)
+  end
+
+end

data/lib/simp/rake/ci.rb

@@ -0,0 +1,31 @@
+require 'rake/tasklib'
+require 'simp/ci/gitlab'
+
+module Simp; end
+module Simp::Rake
+  class Ci < ::Rake::TaskLib
+    def initialize( dir )
+       @base_dir = dir
+       define
+    end
+
+    def define
+      namespace :simp do
+
+        desc 'Validate CI configuration'
+        task :ci_lint => [:gitlab_ci_lint] do
+        end
+
+        desc 'Validate GitLab CI configuration'
+        task :gitlab_ci_lint do
+          # only validation so far is as follows:
+          # - config file is valid YAML
+          # - config file passes GitLab lint check, when GitLab available
+          # - acceptance test job config has valid suites and nodesets
+          Simp::Ci::Gitlab.new(@base_dir).validate_config
+        end
+
+      end
+    end
+  end
+end

data/lib/simp/rake/helpers/version.rb

@@ -2,5 +2,5 @@ module Simp; end
 module Simp::Rake; end
 
 class Simp::Rake::Helpers
-  VERSION = '5.9.1'
+  VERSION = '5.10.0'
 end

data/lib/simp/rake/pupmod/helpers.rb

@@ -2,6 +2,7 @@ require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet/version'
 require 'puppet-syntax/tasks/puppet-syntax'
 require 'puppet-lint/tasks/puppet-lint'
+require 'simp/rake/ci'
 require 'simp/rake/pkg'
 require 'simp/rake/beaker'
 require 'parallel_tests/cli'
@@ -86,6 +87,8 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
 
     Simp::Rake::Beaker.new( @base_dir )
 
+    Simp::Rake::Ci.new( @base_dir )
+
     desc "Run acceptance tests"
     RSpec::Core::RakeTask.new(:acceptance) do |t|
       t.pattern = 'spec/acceptance'

data/spec/lib/simp/ci/files/global_nodesets_only/spec/acceptance/nodesets/default.yml

@@ -0,0 +1,41 @@
+<%
+  if ENV['BEAKER_HYPERVISOR']
+    hypervisor = ENV['BEAKER_HYPERVISOR']
+  else
+    hypervisor = 'vagrant'
+  end
+-%>
+HOSTS:
+  client:
+    roles:
+      - default
+      - master
+      - client
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+  server-1:
+    roles:
+      - server
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+  server-2:
+    roles:
+      - server
+    platform: el-6-x86_64
+    box: centos/6
+    hypervisor: <%= hypervisor %>
+  server-3:
+    roles:
+      - failover_server
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+CONFIG:
+  log_level: verbose
+  type: aio
+  vagrant_memsize: 256
+<% if ENV['BEAKER_PUPPET_COLLECTION'] -%>
+  puppet_collection: <%= ENV['BEAKER_PUPPET_COLLECTION'] %>
+<% end -%>

data/spec/lib/simp/ci/files/global_nodesets_only/spec/acceptance/nodesets/oel.yml

@@ -0,0 +1,41 @@
+<%
+  if ENV['BEAKER_HYPERVISOR']
+    hypervisor = ENV['BEAKER_HYPERVISOR']
+  else
+    hypervisor = 'vagrant'
+  end
+-%>
+HOSTS:
+  client:
+    roles:
+      - default
+      - master
+      - client
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-1:
+    roles:
+      - server
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-2:
+    roles:
+      - server
+    platform: el-6-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-3:
+    roles:
+      - failover_server
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+CONFIG:
+  log_level:       verbose
+  type:            aio
+  vagrant_memsize: 256
+<% if ENV['BEAKER_PUPPET_COLLECTION'] -%>
+  puppet_collection: <%= ENV['BEAKER_PUPPET_COLLECTION'] %>
+<% end -%>

data/spec/lib/simp/ci/files/job_broken_link_nodeset/spec/acceptance/nodesets/centos.yml

@@ -0,0 +1,41 @@
+<%
+  if ENV['BEAKER_HYPERVISOR']
+    hypervisor = ENV['BEAKER_HYPERVISOR']
+  else
+    hypervisor = 'vagrant'
+  end
+-%>
+HOSTS:
+  client:
+    roles:
+      - default
+      - master
+      - client
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+  server-1:
+    roles:
+      - server
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+  server-2:
+    roles:
+      - server
+    platform: el-6-x86_64
+    box: centos/6
+    hypervisor: <%= hypervisor %>
+  server-3:
+    roles:
+      - failover_server
+    platform: el-7-x86_64
+    box: centos/7
+    hypervisor: <%= hypervisor %>
+CONFIG:
+  log_level: verbose
+  type: aio
+  vagrant_memsize: 256
+<% if ENV['BEAKER_PUPPET_COLLECTION'] -%>
+  puppet_collection: <%= ENV['BEAKER_PUPPET_COLLECTION'] %>
+<% end -%>

data/spec/lib/simp/ci/files/job_broken_link_nodeset/spec/acceptance/nodesets/oel.yml

@@ -0,0 +1,41 @@
+<%
+  if ENV['BEAKER_HYPERVISOR']
+    hypervisor = ENV['BEAKER_HYPERVISOR']
+  else
+    hypervisor = 'vagrant'
+  end
+-%>
+HOSTS:
+  client:
+    roles:
+      - default
+      - master
+      - client
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-1:
+    roles:
+      - server
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-2:
+    roles:
+      - server
+    platform: el-6-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+  server-3:
+    roles:
+      - failover_server
+    platform: el-7-x86_64
+    box: onyxpoint/oel-7-x86_64
+    hypervisor: <%= hypervisor %>
+CONFIG:
+  log_level:       verbose
+  type:            aio
+  vagrant_memsize: 256
+<% if ENV['BEAKER_PUPPET_COLLECTION'] -%>
+  puppet_collection: <%= ENV['BEAKER_PUPPET_COLLECTION'] %>
+<% end -%>