puppet-ci-testing 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 550788cd9c65b34842411b5d7ca976b33f5326ce83c975e0629669c380f76098
-  data.tar.gz: 73aece062fb6d483bae81f8865c8a64da5e346363778d80e8df176de3b3dc9e0
+  metadata.gz: 928347f53049919abab4494bef43d7181e015b598b6bbae4688e42070ed498b8
+  data.tar.gz: 379237a85a0ae3c4ef5549c109e84ee69b39df18b5574af3bd04077676d854b8
 SHA512:
-  metadata.gz: e859a8d0a415e0b539a93860f4726e58478070674e09efd56d7af153d8c2cb5e493c83d9c749b55421fa63e92cbbb96478f047fc86f6d1703af62328ad82e29d
-  data.tar.gz: ac2f04edd9ac2b9ad8b8fd732314c6632da606d270f35cd5309adff20ad902cd8ee81135a84b416f1361f277d0e6b4f69690289326b15458b1d1fcbb86e95c2e
+  metadata.gz: 3fc973af4473990e3397fad7ec2d0af3230244a2ecd578b5d3260866cd74740b9951f8fac35d97505ef84789b8bf608d9274c2ced1293a54a364083a162193f3
+  data.tar.gz: 862541f3915b9e0ea356af25abf8442af5342d77b1c9b3c722764bf40e38ee83baf04f12b839934fa1513f4f6b48f25ed5adefa7bc4897928b50a28b06b5c68f

data/bin/check_file_syntax

@@ -58,7 +58,7 @@ EOH
   opts.on('--git-hook', '-g', 'Execute as a Git pre-commit hook') do
     options[:git_hook] = true
   end
-  
+
   opts.on('--initialize', '--init', '-I', 'Setup Git pre-commit hook') do
     # insure that we see the .git directory
     unless Dir.exists? '.git'
@@ -66,26 +66,26 @@ EOH
       puts "Please rerun the command at the top of the Git directory tree."
       exit 1
     end
-    
+
     # insure that the hooks directory exists
     unless Dir.exists? '.git/hooks'
       FileUtils.mkdir '.git/hooks', :mode => 0755
     end
-    
+
     # Now create the pre-commit file unless it exists
     if File.exists? '.git/hooks/pre-commit'
       puts "The Git pre-commit hook already exists (.git/hooks/pre-commit)."
       puts "Please remove this file and rerun the command to create the pre-commit hook."
       exit 1
     end
-    
+
     open('.git/hooks/pre-commit', 'w') do |fp|
-      fp.puts "#{$0} --git-hook || (echo 'puppet-ci-testing gem is not installed' && exit 1)"
+      fp.puts "#{File.basename $0} --git-hook || (echo 'puppet-ci-testing gem is not installed' && exit 1)"
     end
     FileUtils.chmod 0755, '.git/hooks/pre-commit'
     exit 0
   end
-  
+
 end.parse!
 
 # check for an optional directory to

data/lib/check_file_syntax.rb

@@ -2,11 +2,35 @@ require 'colorize'
 require 'json'
 require 'yaml'
 require 'find'
+require 'net/https'
+require 'uri'
+
+module Net
+  class HTTP
+    def self.enable_debug!
+      class << self
+        alias_method :__new__, :new
+        def new(*args, &blk)
+          instance = __new__(*args, &blk)
+          instance.set_debug_output($stderr)
+          instance
+        end
+      end
+    end
 
+    def self.disable_debug!
+      class << self
+        alias_method :new, :__new__
+        remove_method :__new__
+      end
+    end
+  end
+end
 
 module CheckFileSyntax
 
-  ALL_CHECKS = [:puppet, :ruby, :python, :perl, :bash, :erb, :yaml, :json]
+  ALL_CHECKS = [:puppet, :ruby, :python, :perl, :bash, :erb, :yaml, :json,
+                :gitlab_ci]
 
   module_function
   def type_of_file(path, interpreter, extensions)
@@ -57,6 +81,9 @@ module CheckFileSyntax
     type_of_file(path, '---', ['.yaml', '.yml'])
   end
 
+  def gitlab_ci_file?(path)
+    type_of_file(path, :gitlab_ci, '.gitlab-ci.yml')
+  end
 
   module_function
   def show_status (name, success, errors)
@@ -116,14 +143,12 @@ module CheckFileSyntax
         puts 'Consider installing puppet so that syntax can be checked.'.colorize(:yellow)
         status = :skipped
       end
-    end
 
-    if erb_file? path
+    elsif erb_file? path
       errors = `cat #{path} | erb -x -T - | ruby -c 2>&1`
       status = $?.success? ? :passed : :failed
-    end
 
-    if python_file? path
+    elsif python_file? path
       if system('which python >/dev/null')
         errors = `python -m py_compile #{path} 2>&1`
         status = $?.success? ? :passed : :failed
@@ -131,14 +156,12 @@ module CheckFileSyntax
         puts 'Consider installing python so that syntax can be checked.'.colorize(:yellow)
         status = :skipped
       end
-    end
 
-    if ruby_file? path
+    elsif ruby_file? path
       errors = `ruby -c #{path} 2>&1`
       status = $?.success? ? :passed : :failed
-    end
 
-    if perl_file? path
+    elsif perl_file? path
       if system('which perl >/dev/null')
         errors = `perl -c #{path} 2>&1`
         status = $?.success? ? :passed : :failed
@@ -146,15 +169,45 @@ module CheckFileSyntax
         puts 'Consider installing perl so that syntax can be checked.'.colorize(:yellow)
         status = :skipped
       end
-    end
 
-    if bash_file? path
+    elsif bash_file? path
       errors = `bash -n #{path} 2>&1`.to_i
       status = $?.success? ? :passed : :failed
-    end
 
-
-    if json_file? path
+    # GitLab CI files need to be processed before YAML
+    elsif gitlab_ci_file? path
+      ci_content = YAML.load_file(path)
+
+      token_file = ENV['CI_LINT_TOKEN'] || "#{Dir.home}/.gitlab-tokens"
+      if File.readable?(token_file)
+        tokens = YAML.load_file(token_file)
+        # Any token should work
+        priv_token = tokens.values()[0]
+
+        begin
+          uri = URI.parse('https://gitlab.com/api/v4/ci/lint')
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          #Net::HTTP.enable_debug!
+          request = Net::HTTP::Post.new(uri.path, {
+                      'Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'PRIVATE-TOKEN' => 'ShgK6TXXENFtKA5RWC8U'
+                    })
+          request.body = {content: ci_content.to_json}.to_json
+          response = http.request(request)
+        rescue => e
+          puts "Exception: #{e}"
+        end
+        results = JSON.parse(response.body)
+        case results['status']
+        when 'valid'
+          status = :passed
+        when 'invalid'
+          status = :failed
+        end
+      end
+    elsif json_file? path
       begin
         JSON.parse(File.read(path))
         status = :passed
@@ -162,9 +215,8 @@ module CheckFileSyntax
         errors = e.message
         status = :failed
       end
-    end
 
-    if yaml_file? path
+    elsif yaml_file? path
       begin
         YAML.parse(File.read(path))
         status = :passed
@@ -181,4 +233,6 @@ module CheckFileSyntax
       error_count += 1 if status == :failed
     end
   end
-end
+end
+
+

data/spec/check_file_syntax_spec.rb

@@ -1,31 +1,42 @@
 require 'spec_helper'
 require 'check_file_syntax'
+require 'fileutils'
 
 describe CheckFileSyntax do
-  
-  { :json   =>  '.json', 
-    :yaml   =>  ['.yaml','.yml'],
-    :perl   =>  ['.pl','.pm'],
-    :bash   =>  ['.sh','.bash','.zsh','.ksh'],
-    :ruby   =>  '.rb', 
-    :python =>  '.py', 
-    :erb    =>  '.erb',
-    :puppet =>  '.pp' }.each_pair do |type, exts|
+
+  after(:all) do
+    # clean up after testing
+    if Dir.exists? '__pycache__'
+      FileUtils.rm_rf '__pycache__'
+    end
+  end
+
+
+  { :json      =>  '.json',
+    :yaml      =>  ['.yaml','.yml'],
+    :perl      =>  ['.pl','.pm'],
+    :bash      =>  ['.sh','.bash','.zsh','.ksh'],
+    :ruby      =>  '.rb',
+    :python    =>  '.py',
+    :erb       =>  '.erb',
+    :puppet    =>  '.pp',
+    :gitlab_ci => '.gitlab-ci.yml' }.each_pair do |type, exts|
       [exts].flatten.each do |ext|
         it "identifies #{type} with #{ext} extension" do
           expect(CheckFileSyntax::type_of_file("foo#{ext}", type, exts)).to eq true
         end
       end
     end
-  
-  { :json   =>  '.json', 
-    :yaml   =>  ['.yaml','.yml'],
-    :perl   =>  ['.pl','.pm'],
-    :bash   =>  ['.sh','.bash','.zsh','.ksh'],
-    :ruby   =>  '.rb', 
-    :python =>  '.py', 
-    :erb    =>  '.erb',
-    :puppet =>  '.pp' }.each_pair do |type, exts|
+
+  { :json      =>  '.json',
+    :yaml      =>  ['.yaml','.yml'],
+    :perl      =>  ['.pl','.pm'],
+    :bash      =>  ['.sh','.bash','.zsh','.ksh'],
+    :ruby      =>  '.rb',
+    :python    =>  '.py',
+    :erb       =>  '.erb',
+    :puppet    =>  '.pp',
+    :gitlab_ci => '.gitlab-ci.yml' }.each_pair do |type, exts|
       bad_ext = random_string(8)
       [exts].flatten.each do |ext|
         it "fails identifying #{type} without #{ext} extension" do
@@ -33,11 +44,11 @@ describe CheckFileSyntax do
         end
       end
     end
-    
+
   CheckFileSyntax::ALL_CHECKS.each do |type|
     bad_ext ||= random_string(8)
     # Puppet, ERB, JSON and YAML files don't have shebang lines
-    unless [:puppet, :erb, :json, :yaml].include? type
+    unless [:puppet, :erb, :json, :yaml, :gitlab_ci].include? type
       it "identifies content as #{type}" do
         filename = eval "generate_#{type.to_s}(:valid, extension:'.#{bad_ext}')"
         expect(CheckFileSyntax::type_of_file(filename, type, '.foo')).to eq true
@@ -45,15 +56,21 @@ describe CheckFileSyntax do
       end
     end
   end
-  
+
   CheckFileSyntax::ALL_CHECKS.each do |type|
     it "identifies valid syntax of #{type}" do
-      filename = eval "generate_#{type.to_s}(:valid)"
-      CheckFileSyntax::check_file_syntax(filename) { |path, status, errors|
-        expect(status).to eq :passed
-      }
+      begin
+        filename = eval "generate_#{type.to_s}(:valid)"
+        CheckFileSyntax::check_file_syntax(filename) { |path, status, errors|
+          expect(status).to eq :passed
+        }
+      rescue Exception => e
+        puts e
+      end
       File.unlink filename
-      File.unlink "#{filename}c" if type == :python
+      if type == :python and File.exists? "#{filename}c"
+        File.unlink "#{filename}c"
+      end
     end
   end
 
@@ -66,5 +83,5 @@ describe CheckFileSyntax do
       File.unlink filename
     end
   end
-  
+
 end

data/spec/file_generators.rb

@@ -0,0 +1,211 @@
+def generate_json(validity, extension: '.json')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+{
+  "test": "good JSON",
+  "foo": "bar"
+}
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+{
+  "test": "bad JSON"
+  "foo": "bar"
+}
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_yaml(validity, extension: '.yaml')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+---
+  test: "good YAML"
+  foo: "bar"
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+===
+  test: "bad YAML",
+  foo: "bar"
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_ruby(validity, extension: '.rb')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env ruby
+puts "valid ruby!"
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env ruby
+put "invalid ruby!'
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_python(validity, extension: '.py')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env python
+print("valid python!")
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env python
+print("invalid python!')
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_perl(validity, extension: '.pl')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env perl
+print "valid ";
+print "perl!"
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/usr/bin/env perl
+print "invalid "
+print "perl!"
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_bash(validity, extension: '.sh')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/bin/bash
+echo "valid shell!"
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+#!/bin/bash
+echo "invalid shell!'
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_erb(validity, extension: '.erb')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+<% puts "valid erb!" %>
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+<% puts "invalid "  <%= erb!" %>
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_puppet(validity, extension: '.pp')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+puppet { 'good': }
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+puppet { "bad" }
+EOF
+    end
+  end
+
+  return filebase + extension
+end
+
+
+def generate_gitlab_ci(validity, extension: '.gitlab-ci.yml')
+  filebase = random_string(16)
+  if validity == :valid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+stages:
+  - stage1
+
+job1:
+  stage: stage1
+  script:
+    - echo "test"
+EOF
+    end
+  elsif validity == :invalid
+    open(filebase + extension, 'w') do |fh|
+      fh.puts <<EOF
+stages:
+  stage1:
+
+job1:
+  stage: stage2
+  script:
+    echo "test"
+    echo "test2"
+EOF
+    end
+  end
+
+  return filebase + extension
+end

data/spec/spec_helper.rb

@@ -102,187 +102,8 @@ RSpec.configure do |config|
 =end
 end
 
+require 'file_generators'
+
 def random_string(size=10)
   (0..size).map { ('a'..'z').to_a[rand(26)] }.join
 end
-
-
-def generate_json(validity, extension: '.json')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-{
-  "test": "good JSON",
-  "foo": "bar"
-}
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-{
-  "test": "bad JSON"
-  "foo": "bar"
-}
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_yaml(validity, extension: '.yaml')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
----
-  test: "good YAML"
-  foo: "bar"
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-===
-  test: "bad YAML",
-  foo: "bar"
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_ruby(validity, extension: '.rb')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env ruby
-puts "valid ruby!"
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env ruby
-put "invalid ruby!'
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_python(validity, extension: '.py')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env python
-print("valid python!")
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env python
-print("invalid python!')
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_perl(validity, extension: '.pl')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env perl
-print "valid ";
-print "perl!"
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/usr/bin/env perl
-print "invalid "
-print "perl!"
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_bash(validity, extension: '.sh')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/bin/bash
-echo "valid shell!"
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-#!/bin/bash
-echo "invalid shell!'
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_erb(validity, extension: '.erb')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-<% puts "valid erb!" %>
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-<% puts "invalid "  <%= erb!" %>
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-
-
-def generate_puppet(validity, extension: '.pp')
-  filebase = random_string(16)
-  if validity == :valid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-puppet { 'good': }
-EOF
-    end
-  elsif validity == :invalid
-    open(filebase + extension, 'w') do |fh|
-      fh.puts <<EOF
-puppet { "bad" }
-EOF
-    end
-  end
-  
-  return filebase + extension
-end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-ci-testing
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Gerard Hickey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -207,12 +207,13 @@ files:
 - lib/check_file_syntax.rb
 - lib/simple_junit.rb
 - spec/check_file_syntax_spec.rb
+- spec/file_generators.rb
 - spec/simple_junit_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/hickey/puppet-ci-testing/
+homepage: https://gitlab.com/wt0f/puppet-ci-testing/
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -227,8 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Utilities to perform Puppet testing in a CI workflow
 test_files: []