Merge pull request #1 from nichtraunzer/feature/createmodule-script

run rubocop  --auto-correct-all

Author: nichtraunzer

.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*"
+Naming/ClassAndModuleCamelCase:
+  Description: Use CamelCase for classes and modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#camelcase-classes
+  Enabled: true
+Naming/MethodName:
+  Description: Use the configured style when naming methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
+  Enabled: true
+  EnforcedStyle: camelCase
+  SupportedStyles:
+  - snake_case
+  - camelCase
+Naming/VariableName:
+  Description: Use the configured style when naming variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
+  Enabled: true
+  EnforcedStyle: camelCase
+  SupportedStyles:
+  - snake_case
+  - camelCase

hooks/createbpmoduleoutputs.sh

@@ -35,7 +35,7 @@ for adir in ${FIXTURE_DIRS} ; do
   # Only select the blueprint name which refers to the module in ../../..
   MODULE_NAMES=$(terraform-config-inspect . --json| jq -r '.module_calls|.[]|select(.source=="../../..")|.name')
 
-  echo "# file created automatically" > "${TFMFILE}"
+  printf "# This file has been created automatically.\n\n" > "${TFMFILE}"
 
   #for modules in $(terraform-config-inspect . --json| jq -r '.module_calls|keys[]') ; do
 

hooks/createi2o.sh

@@ -28,6 +28,8 @@ fi
 TFDOCSHCL=$(terraform-docs tfvars json "${CWD}" | jq -r 'keys[] as $k | "\($k) = var.\($k)"' | indenttfo )
 
 cat > "${TFHFILE}" <<EOF
+# This file has been created automatically.
+
 output "inputs2outputs" {
   description = "all inputs passed to outputs"
   value = [{

hooks/createstackmoduleoutputs.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # createstackmoduleoutputs.rb
 # Author: erhard.wais@boehringer-ingelheim.com
@@ -16,24 +18,38 @@
 require 'json'
 require 'open3'
 
-INSPECAWS        = ""
-INSPECAWSTAG     = ""
-CAPTUREFROMSTACK = 'terraform-config-inspect --json'
-ENVNAME          = 'KITCHEN_SUITE_NAME'
-OUTPUTSTF        = './stackmodulesoutputs.tf'
-BANNER           = "# This file has been created automatically.\n\n"
-BANNER2          = "name: stackdefault\n" + "supports:\n" + "  - platform: aws\n" + "depends:\n" + "  - name: inspec-aws\n" + "    git: https://github.com/inspec/inspec-aws\n" + "    tag: v1.33.0\n" + "# Begin - blueprint inspec profiles\n"
-
-stdout, stderr, status = Open3.capture3(CAPTUREFROMSTACK)
-
-myEnv         = ENV.fetch(ENVNAME,"default")
-moduleNames   = Hash.new
-moduleSources = Hash.new
+CAPTUREFROMSTACK  = 'terraform-config-inspect --json'
+ENVNAME           = 'KITCHEN_SUITE_NAME'
+OUTPUTSTF         = './stackmodulesoutputs.tf'
+BANNER            = "# This file has been created automatically.\n\n"
+INSPECYMLTMPLFILE = './test/integration/default/inspec.yml.tmpl'
+INSPECYMLTMPLSTR  = <<~MYYML
+    ---
+    name: stackdefault
+    supports:
+      - platform: aws
+    depends:
+      - name: inspec-aws
+        git: https://github.com/inspec/inspec-aws
+        tag: v1.33.0
+MYYML
+
+INSPECYMLHEAD = if File.exist?(INSPECYMLTMPLFILE)
+                  File.read(INSPECYMLTMPLFILE)
+                else
+                  INSPECYMLTMPLSTR
+                end
+
+stdout, _stderr, _status = Open3.capture3(CAPTUREFROMSTACK)
+
+myEnv         = ENV.fetch(ENVNAME, 'default')
+moduleNames   = {}
+moduleSources = {}
 uniqueBP      = Hash.new(0)
 
-CAPTUREFROMFIXTURE   = "terraform-config-inspect ./test/fixtures/#{myEnv} --json"
+CAPTUREFROMFIXTURE = "terraform-config-inspect ./test/fixtures/#{myEnv} --json"
 
-stdoutfixture, stderrfixture, statusfixture = Open3.capture3(CAPTUREFROMFIXTURE)
+stdoutfixture, _stderrfixture, _statusfixture = Open3.capture3(CAPTUREFROMFIXTURE)
 
 stackName   = File.basename(Dir.getwd)
 outputTF    = File.open(OUTPUTSTF, 'w')
@@ -45,107 +61,106 @@
 modoutTF.write(BANNER)
 allBPsRB.write(BANNER)
 inspecYML.write(BANNER)
-inspecYML.write(BANNER2)
+inspecYML.write(INSPECYMLHEAD)
 
 # get module section from main.json
 allModules = JSON.parse(stdout)['module_calls']
 allModulesfixtures = JSON.parse(stdoutfixture)['module_calls']
 
-fixturemodulename = ""
-allModulesfixtures.each do |singleModule|
-  fixturemodulename = singleModule[0]
+fixturemodulename = ''
+allModulesfixtures.each do |singlemodule|
+  fixturemodulename = singlemodule[0]
 end
 
 # for each module
-allModules.each do |singleModule|
-
+allModules.each do |singlemodule|
   # get modulename and attributes
-  name      = singleModule[0]
-  attribute = singleModule[1]
+  name      = singlemodule[0]
+  attribute = singlemodule[1]
 
   moduleOut    = name
   moduleValue  = "#{name}.*"
   fileName     = attribute['source']
-  moduleBP     = File.basename(fileName[0..fileName.index('git?ref')], ".*")
+  moduleBP     = File.basename(fileName[0..fileName.index('git?ref')], '.*')
 
   # create helper hashes to track which module uses which BP and how often
   moduleNames[moduleOut]  = moduleBP
   moduleSources[moduleBP] = fileName
   uniqueBP[moduleBP]     += 1
 
-# create outputX.tf
- outputTF.write("output \"module_#{moduleOut.gsub(/-/,"_")}\" {\n")
- outputTF.write("  value = module.#{moduleValue}\n}\n")
+  # create outputX.tf
+  outputTF.write("output \"module_#{moduleOut.gsub(/-/, '_')}\" {\n")
+  outputTF.write("  value = module.#{moduleValue}\n}\n")
 end
 
 # create moduleoutputs.tf
-stackOut   = stackName.gsub(/-/,"_")
-stackValue = "module.#{stackOut}_default"
+stackOut = stackName.gsub(/-/, '_')
+# FIXME#stackValue = "module.#{stackOut}_default"
 
 modoutTF.write("output \"module_#{stackOut}\" {\n")
 modoutTF.write("  value = module.#{fixturemodulename}.*\n}\n")
 
 uniqueBP.each do |name, count|
-  duplicates   = Array.new
+  duplicates = []
 
-  moduleNames.select { |k, v| v == name }.keys.each {|dup| duplicates << dup}
+  moduleNames.select { |_k, v| v == name }.each_key { |dup| duplicates << dup }
 
   if count == 1
-    moduleValue = "module.#{fixturemodulename}.module_#{duplicates[0].gsub(/-/,"_")}.*"
+    moduleValue = "module.#{fixturemodulename}.module_#{duplicates[0].gsub(/-/, '_')}.*"
     moduleV2    = "module.#{duplicates[0]}.*"
   else
-    moduleValue = "concat("
-    duplicates.each_index {|i| moduleValue += "module.#{fixturemodulename}.module_#{duplicates[i].gsub(/-/,"_")}.*,"}
-    moduleValue = moduleValue[0...-1] + ")"
+    moduleValue = 'concat('
+    duplicates.each_index { |i| moduleValue += "module.#{fixturemodulename}.module_#{duplicates[i].gsub(/-/, '_')}.*," }
+    moduleValue = "#{moduleValue[0...-1]})"
 
-    moduleV2 = "concat("
-    duplicates.each_index {|i| moduleV2 += "module.#{duplicates[i]}.*,"}
-    moduleV2 = moduleV2[0...-1] + ")"
+    moduleV2 = 'concat('
+    duplicates.each_index { |i| moduleV2 += "module.#{duplicates[i]}.*," }
+    moduleV2 = "#{moduleV2[0...-1]})"
   end
 
-  moduleOut    = name.gsub(/-/,"_")
-  modoutTF.write( "output \"module_#{moduleOut}\" {\n")
-  modoutTF.write( "  value = #{moduleValue}\n}\n")
+  moduleOut = name.gsub(/-/, '_')
+  modoutTF.write("output \"module_#{moduleOut}\" {\n")
+  modoutTF.write("  value = #{moduleValue}\n}\n")
 
   # write stackmoduleoutputs.tf
-  outputTF.write("output \"module_#{moduleOut.gsub(/-/,"_")}\" {\n")
+  outputTF.write("output \"module_#{moduleOut.gsub(/-/, '_')}\" {\n")
   outputTF.write("  value = #{moduleV2}\n}\n")
 
   # read the source/filename from the helper hash
-  fileName  = moduleSources.select { |k, v| k == name }[name]
+  fileName  = moduleSources.select { |k, _v| k == name }[name]
 
   # check if is repository and if it is a BI blueprint
   hasGit    = fileName.index('git::')
   hasGitRef = fileName.index('.git?ref')
   isBP      = fileName.index('blueprint')
 
-  if isBP
-    # write blueprints.rb
-    allBPsRB.write("include_controls '#{moduleOut}'\n")
-
-    # write inspec.yml
-    inspecYML.write("  - name: #{moduleOut}\n")
-
-    if hasGit
-      # puts " ... Tag      #{fileName[(hasGitRef + 9)..]} "
-      # puts " ... url      #{fileName[(hasGit + 5)..(hasGitRef + 3)]} "
-      # add +9 = length of .git?ref + 1
-      inspecYML.write("    git: #{fileName[(hasGit + 5)..(hasGitRef + 3)]}\n")
-      inspecYML.write("    tag: #{fileName[(hasGitRef + 9)..]}\n")
-      inspecYML.write("    relative_path: test/integration/#{myEnv}\n")
-    else
-      inspecYML.write("    path: ../../../#{fileName}\n")
-    end
+  next unless isBP
+
+  # write blueprints.rb
+  allBPsRB.write("include_controls '#{moduleOut}'\n")
+
+  # write inspec.yml
+  inspecYML.write("  - name: #{moduleOut}\n")
+
+  if hasGit
+    # puts " ... Tag      #{fileName[(hasGitRef + 9)..]} "
+    # puts " ... url      #{fileName[(hasGit + 5)..(hasGitRef + 3)]} "
+    # add +9 = length of .git?ref + 1
+    inspecYML.write("    git: #{fileName[(hasGit + 5)..(hasGitRef + 3)]}\n")
+    inspecYML.write("    tag: #{fileName[(hasGitRef + 9)..]}\n")
+    inspecYML.write("    relative_path: test/integration/#{myEnv}\n")
+  else
+    inspecYML.write("    path: ../../../#{fileName}\n")
   end
 end
 
-outputTF.close unless outputTF.nil?
-modoutTF.close unless modoutTF.nil?
-allBPsRB.close unless allBPsRB.nil?
+outputTF&.close
+modoutTF&.close
+allBPsRB&.close
 inspecYML.close unless allBPsRB.nil?
 
 # pretty format modified tf files, so that a cyclic execution of terraform fmt is prohibited.
-TFFMT = "terraform fmt"
+TFFMT = 'terraform fmt'
 stdouttffmt, stderrtffmt, statustffmt = Open3.capture3(TFFMT)
 pp stdouttffmt
 pp stderrtffmt

ods-pre-commit-hooks-ruby.gemspec

@@ -1,32 +1,30 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
-  s.name = %q{ods-pre-commit-hooks-ruby}
-  s.version = "0.0.1"
+  s.required_ruby_version = '~> 2.6'
+  s.name = 'ods-pre-commit-hooks-ruby'
+  s.version = '0.0.2'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Josef Hartmann / Erhard Wais"]
-  s.email = %q{dontneedmoreemail@domain.com}
-  s.files = Dir["./hooks/*.rb"]
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Josef Hartmann / Erhard Wais']
+  s.email = 'dontneedmoreemail@domain.com'
+  s.files = Dir['./hooks/*.rb']
   s.bindir = 'hooks'
-  s.executables   = s.files.grep(%r{^./hooks/}) { |f| File.basename(f) }
-  s.require_paths    = ["hooks"]
-  s.extra_rdoc_files = ["README.md"]
-  s.homepage = %q{https://github.com/nichtraunzer/ods-pre-commit-hooks}
-  s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.executables = s.files.grep(%r{^./hooks/}) { |f| File.basename(f) }
+  s.require_paths    = ['hooks']
+  s.extra_rdoc_files = ['README.md']
+  s.homepage = 'https://github.com/nichtraunzer/ods-pre-commit-hooks'
+  s.rdoc_options = ['--main', 'README.md']
+  s.rubygems_version = '1.3.7'
   s.license = 'Apache-2.0'
-  s.summary = "ruby pre-commit hooks for the ods ecosystem."
-  s.description = "A git pre-commit hook written in ruby."
+  s.summary = 'ruby pre-commit hooks for the ods ecosystem.'
+  s.description = 'A git pre-commit hook written in ruby.'
 
   s.add_development_dependency('benchmark-ips',  '~> 0.1')
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('minitest-reporters', '~> 1.0')
   s.add_development_dependency('rake', '~> 10.0')
-  s.add_development_dependency('rubocop', '~> 0.49')
+  s.add_development_dependency('rubocop', '~> 1.9')
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-  end
+  s.specification_version = 3 if s.respond_to? :specification_version
 end