reagan 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcd3469e7bc317073069aca8545749fc91e2deeb
-  data.tar.gz: 839ce97f7831bb90a2dfe4471e2378bac9abd954
+  metadata.gz: 38f1709f20a9992d8685abf028ab706efc1fd584
+  data.tar.gz: a20e5db170d66837c2711e3c9aae10f35616d885
 SHA512:
-  metadata.gz: e8b5229fabf0a74cb6ecdb940eab38cabc80bdb05a84c902a2d6a24b4e2df8eb8d9aa0768b9150aee6364e2dd0b338d75fdaab11389c316458fac7ed24536b48
-  data.tar.gz: 3f9918f84823b43ca7219d4defab2ef6a910adea416bc02e7e8919cfc0eab51437e6e2ac1817a0f7c4c938d98474001dc4db592c2edccdba8e84977ca96d8eb9
+  metadata.gz: f112be2741f0cd51aaa0db555f011024edaa6d5403d9e59ed58b687c7f65acdb21c386011da6508da874d1e386d5a03c0a87e58bc134b2912557abbf5b0a9db7
+  data.tar.gz: 399fc3e48f8c2d483eed5fb991f38cacbc54d22d3831ccace9871e68c529257f6eeb5b7ceef6c9af39cb227dd0e5dcae81b9e5074b0c008073c9344a72f2a4e2

data/bin/reagan

@@ -27,7 +27,7 @@ flags = { :pull => nil, :cookbooks => nil, :config => '/etc/reagan.yml' }
 parser = OptionParser.new do |opts|
   opts.banner = 'Usage: reagan [options]'
   opts.on('-o', '--override cb1,cb2', 'Comma separated list of cookbooks to test') do |cookbooks|
-    flags[:cookbooks] = cookbooks
+    flags[:override_cookbooks] = cookbooks
   end
 
   opts.on('-p', '--pull_num 123', 'Github pull number to test') do |pull|

data/lib/change.rb

@@ -28,49 +28,72 @@ end
 class Change < Reagan
   attr_accessor :files
   def initialize
-    @files = list_files_changed
+    @files = files_to_test
   end
 
-  def unique_cookbooks(files)
-    cookbooks = []
-    files.each do |file|
-      path_array = file.split('/')
-      cookbooks << path_array[1] if path_array[0].match('^cookbooks')
+  # return hash of json files / cookbooks that have been changed
+  def files_to_test
+    if @@config['flags']['override_cookbooks']
+      files_from_override
+    else
+      pull = pull_num
+      puts "Grabbing contents of pull request #{pull}\n"
+      hash_builder(query_gh(pull))
     end
-    cookbooks.to_set
   end
 
-  def files_from_pull(pull_changes)
-    files = []
-    pull_changes.each do |file|
-      files << file[:filename]
-    end
+  # build a files hash based on the override cookbooks passed by the user
+  def files_from_override
+    files = {}
+    files['json'] = []
+    files['cookbooks'] = @@config['flags']['override_cookbooks'].split(',')
     files
   end
 
+  # fetch pull num from either ENV or CLI param
   def pull_num
     if @@config['flags']['pull']
       pull = @@config['flags']['pull']
     elsif ENV['ghprbPullId']
       pull = ENV['ghprbPullId']
     else
-      fail 'Jenkins ghprbPullId environmental variable not set or --pull option not used.  Cannot continue'
+      puts 'Jenkins ghprbPullId environmental variable not set or --pull option not used.  Cannot continue'
+      exit 1
     end
     pull
   end
 
-  # return list of cookbooks changed either from override value or from polling github pull request
-  def list_files_changed
-    if @@config['flags']['cookbooks']
-      @@config['flags']['cookbooks'].split(',')
-    else
-      pull = pull_num
-      puts "Grabbing contents of pull request #{pull}\n"
+  # queries github for the files that have changed
+  def query_gh(pull_num)
+    gh = Octokit::Client.new(:access_token => @@config['github']['auth_token'])
+    files_from_pull(gh.pull_request_files(@@config ['github']['repo'], pull_num))
+  end
+
+  # convert pull request response to array of changed files
+  def files_from_pull(pull_changes)
+    files = []
+    pull_changes.each do |file|
+      files << file[:filename]
+    end
+    files
+  end
 
-      gh = Octokit::Client.new(:access_token => @@config['github']['auth_token'])
+  # builds a hash of files / cookbooks that changed based on the pull data from GH
+  def hash_builder(pull_files)
+    files = {}
+    files['json'] = []
+    files['cookbooks'] = []
+    cookbooks = []
+
+    pull_files.each do |file|
+      # populate json array if file is json
+      files['json'] << file && next if file.match('.json$')
 
-      pull_files = files_from_pull(gh.pull_request_files(@@config ['github']['repo'], pull))
-      unique_cookbooks(pull_files)
+      # populate cookbooks array if filename starts with cookbooks
+      cookbooks << file.split('/')[1]   if  file.match('^cookbooks')
     end
+    # set cookbooks array to set to dedupe list of cookbooks
+    files['cookbooks'] = cookbooks.to_set
+    files
   end
 end

data/lib/config.rb

@@ -33,28 +33,25 @@ class ReaganConfig
 
   # loads the reagan.yml config file from /etc/reagan.yml or the passed location
   def load_config_file
-    begin
-      config = YAML.load_file(@flags[:config])
-      if config == false
-        puts "ERROR: Reagan config at #{@flags[:config]} does not contain any configuration data"
-        exit 1
-      end
-      config
-    rescue Errno::ENOENT
-      puts "ERROR: Cannot load Reagan config file at #{@flags[:config]}"
-      exit 1
-    rescue Psych::SyntaxError
-      puts "ERROR: Syntax error in Reagan config file at #{@flags[:config]}"
+    config = YAML.load_file(@flags[:config])
+    if config == false
+      puts "ERROR: Reagan config at #{@flags[:config]} does not contain any configuration data"
       exit 1
     end
+    config
+  rescue Errno::ENOENT
+    puts "ERROR: Cannot load Reagan config file at #{@flags[:config]}"
+    exit 1
+  rescue Psych::SyntaxError
+    puts "ERROR: Syntax error in Reagan config file at #{@flags[:config]}"
+    exit 1
   end
 
   # join the config file with the passed flags into a single object
   def build_config
     config = @config_file
     config['flags'] = {}
-    @flags.each{|k,v| config['flags'][k.to_s]=v}
+    @flags.each { |k, v| config['flags'][k.to_s] = v }
     config
   end
-
 end

data/lib/reagan.rb

@@ -23,11 +23,12 @@ class Reagan
   require 'test_knife'
   require 'test_version'
   require 'test_reagan'
+  require 'test_json'
 
   attr_accessor :config
   def initialize(flags)
     @@config = ReaganConfig.new(flags).settings
-    @cookbooks = Change.new.files
+    @changes = Change.new.files
   end
 
   # nicely prints marques
@@ -39,26 +40,31 @@ class Reagan
 
   # run tests on each changed cookbook
   def run
-    # exit with a friendly message if no cookbooks have been changed
-    if @cookbooks.empty?
+    # exit with a friendly message if nothing we test has been changed
+    if @changes['json'].empty? && @changes['cookbooks'].empty?
       pretty_print('Nothing to test in this change. Reagan approves')
       exit 0
     end
 
-    pretty_print('The following cookbooks will be tested')
-    @cookbooks.each { |cb| puts cb }
+    pretty_print('The following cookbooks & json files will be tested')
+    @changes['cookbooks'].each { |cb| puts cb }
+    @changes['json'].each { |json| puts json }
 
     results = []
-    @cookbooks.each do |cookbook|
+    @changes['cookbooks'].each do |cookbook|
       pretty_print("Testing cookbook #{cookbook}")
       results <<  TestKnife.new(cookbook).test
       results << TestVersion.new(cookbook).test
       results <<  TestReagan.new(cookbook).test
     end
+    @changes['json'].each do |file|
+      pretty_print("Testing JSON file #{file}")
+      results <<  TestJSON.new(file).test
+    end
 
     # print success or failure
     failure = results.include?(false)
-    text = failure ? "Reagan testing has failed" : "All Reagan tests have suceeded"
+    text = failure ? 'Reagan testing has failed' : 'All Reagan tests have suceeded'
     pretty_print(text)
 
     # if any test failed then exit 1 so jenkins can pick up the failure

data/lib/test_json.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+#
+# Author:: Tim Smith (<tim@cozy.co>)
+# Copyright:: Copyright (c) 2014 Tim Smith
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+begin
+  require 'json'
+rescue LoadError => e
+  raise "Missing gem or lib #{e}"
+end
+
+# tests to make sure the version has been updated on the cookbook
+class  TestJSON < Reagan
+  def initialize(file)
+    @file = file
+  end
+
+  # performs JSON format test
+  # returns  true if json can be parsed and false if it cannot
+  def test
+    puts "Running JSON parsing test:"
+    begin
+      json_file = File.read(File.join(@@config['jenkins']['workspace_dir'], @file))
+      JSON.parse(json_file)
+      success = true
+    rescue JSON::JSONError
+      success = false
+    end
+    puts success ? "    PASS: JSON parses" : "    FAIL: JSON does NOT parse"
+    success
+  end
+end

data/lib/test_version.rb

@@ -40,13 +40,18 @@ class  TestVersion < Reagan
   # grab the most recent version of the cookbook on the chef server
   def check_server_version
     Ridley::Logging.logger.level = Logger.const_get 'ERROR'
-    server_con = Ridley.new(
-        server_url: @@config['chef']['server_url'],
-        client_name: @@config['chef']['client_name'],
-        client_key: @@config['chef']['pem_path'],
-        ssl: { verify: false }
-      )
-    server_con.cookbook.all[@cookbook][0]
+    begin
+      server_con = Ridley.new(
+          server_url: @@config['chef']['server_url'],
+          client_name: @@config['chef']['client_name'],
+          client_key: @@config['chef']['pem_path'],
+          ssl: { verify: false }
+        )
+      server_con.cookbook.all[@cookbook][0]
+    rescue Ridley::Errors::ConnectionFailed
+      puts '    ERROR: Failed to connect to the Chef server. Cannot continue'
+      exit 1
+    end
   end
 
   # performs version update test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reagan
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Tim Smith
@@ -83,6 +83,7 @@ files:
 - lib/change.rb
 - lib/config.rb
 - lib/reagan.rb
+- lib/test_json.rb
 - lib/test_knife.rb
 - lib/test_reagan.rb
 - lib/test_version.rb