mofa 0.5.5 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b253d74784ec5ffc5b796f2387a69f55bbc448e4
-  data.tar.gz: dfcc89442b03ae56137d1474348c28b1ef5b9c96
+SHA256:
+  metadata.gz: 2c1eb88f1c036d2fde056ffc49cedba0bd79e952abd9bd66373fa8df0729f5a1
+  data.tar.gz: b0482279a20d8a1988f4e82bb2132cb62f071e7d06265cb9bf75a1b994a1bcd4
 SHA512:
-  metadata.gz: 05b0a881191afd9f165bb373ae85f1378aeec54e1224b9142892f7815b58924d3168b9e4f27e38feeff30f287d77e2550695a2194c76f5188b64d6234d8c195d
-  data.tar.gz: 12e2852d42432b68fbae89a09d45bd47a743b0761ce0e3afaac4cbe70d1d57bdac3bd51f0c40bbde324f7f88d061168beae7abb651218396f78292c5261bfad1
+  metadata.gz: a8960aae289ce4d22fdbcc0b5f6804a61e3b34a21e674176791c8d1ab2d013701f6ac1359b6ed64a58231319a5820c49f2141e80fcea6063a38d72ca9a598a55
+  data.tar.gz: a1280c2d557f7c7a53ebd1cfc5ccb00820b82320c58ab326380ab73ec6ae6cb2d55adf24d87160d66b60fd444648ae6d68ce530b6bb06bfb516698cd905da29f

data/.gitignore

@@ -7,4 +7,6 @@ pkg/*
 
 example_hostlist.json
 
+vendor/bundle
+
 

data/.rubocop.yml

@@ -1,9 +1,15 @@
+Metrics/ParameterLists:
+  Enabled: false
+
 Metrics/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/ClassLength:
   Enabled: false
 

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM docker.io/chef/chefdk:1.6.11
+
+RUN apt update && apt upgrade --yes && \
+  apt install build-essential rsync --yes && \
+  gem install mofa
+
+RUN mkdir /root/.mofa
+
+COPY config.docker.yml /root/.mofa/config.yml
+
+ENV PATH="/root/.chefdk/gem/ruby/2.3.0/bin:${PATH}"
+

data/README.md

@@ -52,7 +52,7 @@ Before you can start using mofa please create a config file:
 
 # local Development
 
-    $ git clone https://github.com/hybris/mofa.git
+    $ git clone https://github.com/pingworks/mofa.git
     $ cd mofa
     $ bundle install
     $ cd ../somewhere_chef-env_some_cookbook

data/config.docker.yml

@@ -0,0 +1,39 @@
+# global mofa settings
+
+# Admin User Account that should be used for all mofa tasks.
+# The user has to be able to login passwordless
+# and has tohave passwordless sudo permissions.
+ssh_user: sccchef
+ssh_keyfile: ~/.ssh/id_rsa_sccchef
+
+# where to build tmporary cookbook packages and so on
+tmp_dir: /var/tmp
+
+# A REST-Webservice that returns a list of hosts that are potentially
+# manageable with this mofa.
+service_hostlist_url: file:///opt/workshopbox/etc/hostlist.json
+service_hostlist_default_filter: "localhost"
+#service_hostlist_api_key: xyz
+
+# The cookbook architectural pattern should becodified by following
+# a coonaming schema:
+# * Cookbooks beginning with "env_*" are Envrionment Cookbooks
+# * Cookbooks haven a prefix like "<organisation_name>_*" are
+#   so-called Wrapper Cookbooks
+# * Cookbooks having a "base_" Prefix are Base Cookbooks
+
+cookbook_type_indicator:
+  env: "^env_.*"
+  wrapper: "^(scc_|fos_|allcop_).*"
+  base: ".*_base$"
+
+# Binrepo for released cookbooks
+binrepo_base_url: 'https://berks-api/cookbooks'
+
+# Releasing into binrepo
+binrepo_host: berks-api
+binrepo_ssh_user: berks
+binrepo_ssh_port: 22
+binrepo_ssh_keyfile: /id_rsa
+binrepo_import_dir: /data/cookbooks/import
+

data/lib/mofa/attributes_map.rb

@@ -47,10 +47,16 @@ class AttributesMap
       elsif value.is_a?(Array)
         new_attr_hash[key] = []
         value.each do |value_item|
-          new_attr_hash[key].push(value_item.gsub(Regexp.new(Regexp.escape(placeholder)), content))
+          if value_item.is_a?(Hash)
+            new_attr_hash[key] = deep_parse(value, placeholder, content)
+          else
+            new_attr_hash[key].push(value_item.gsub(Regexp.new(Regexp.escape(placeholder)), content))
+          end
         end
       else
-        new_attr_hash[key] = value.gsub(Regexp.new(Regexp.escape(placeholder)), content)
+        if value
+          new_attr_hash[key] = value.gsub(Regexp.new(Regexp.escape(placeholder)), content)
+        end
       end
     end
     new_attr_hash

data/lib/mofa/cli.rb

@@ -16,13 +16,17 @@ module Mofa
     class_option :debug, :type => :boolean, :aliases => '-vv', :desc => 'be very vebose'
 
     desc 'provision <cookbook>', 'provisions Targethost(s) using a given cookbook.'
-    method_option :ignore_ping, :type => :boolean, :aliases => '-p'
+    method_option :ignore_ping, :type => :boolean, :aliases => '-P'
     method_option :target, :type => :string, :aliases => '-t'
     method_option :concrete_target, :type => :string, :aliases => '-T'
     method_option :runlist, :type => :string, :aliases => '-o'
     method_option :attributes, :type => :string, :aliases => '-j'
     method_option :service_hostlist_url, :type => :string
     method_option :override_mofa_secrets, :type => :string, :aliases => '-S'
+    method_option :ssh_port, :type => :string, :aliases => '-p', :default => '22'
+    method_option :ssh_user, :type => :string, :aliases => '-u', :default => 'sccchef'
+    method_option :ssh_keyfile, :type => :string, :aliases => '-i',  :default => '~/.ssh/id_rsa_sccchef'
+    method_option :tmp_dir, :type => :string, :aliases => '-w', :default => '~/tmp/mofa'
 
     def provision(cookbook_name_or_path)
       set_verbosity
@@ -30,7 +34,6 @@ module Mofa
       cookbook_name_or_path ||= '.'
 
       target_filter = options[:target]
-      #target_filter ||= Mofa::Config.config['profiles']['default']['target']
 
       token = MofaCmd.generate_token
 
@@ -47,12 +50,13 @@ module Mofa
       cmd.options = options
 
       cmd.prepare
-      cmd.execute
+      cmd.execute(options[:ssh_port], options[:ssh_user], options[:ssh_keyfile])
       cmd.cleanup
     end
 
     desc 'upload <cookbook>', 'package & upload cookbook into binrepo'
     method_option :binrepo_host, :type => :string
+    method_option :binrepo_ssh_port, :type => :string
     method_option :binrepo_ssh_user, :type => :string
     method_option :binrepo_ssh_keyfile, :type => :string
 
@@ -67,7 +71,8 @@ module Mofa
       cmd = UploadCmd.new(token, cookbook)
 
       cmd.prepare
-      cmd.execute
+      # FIXME: bring in the ssh-port in a different way
+      cmd.execute(22)
       cmd.cleanup
     end
 
@@ -77,29 +82,6 @@ module Mofa
       puts VERSION
     end
 
-    desc 'config', 'prints out mofa config.'
-
-    def config
-      config_print
-    end
-
-    desc 'setup', 'setup initial configuration'
-
-    def setup
-      set_verbosity
-
-      case
-        when !File.exists?("#{ENV['HOME']}/.mofa/config.yml")
-          begin
-            config_create
-          end until config_valid?
-        else
-          begin
-            config_edit
-          end until config_valid?
-      end
-    end
-
     def self.option_verbose
       @@option_verbose
     end
@@ -128,33 +110,6 @@ module Mofa
       say detail, :red
     end
 
-    def config_create
-      say 'Creating a new mofa config (~/.mofa/config.yml)...'
-
-      say '- not implemented yet -'
-
-    end
-
-    def config_edit
-      say 'Editing mofa config (~/.mofa/config.yml)...'
-
-      say '- not implemented yet -'
-
-    end
-
-    def config_print
-      say 'Mofa Config (~/.mofa/config.yml):'
-
-      say '- not implemented yet -'
-
-    end
-
-    def config_valid?
-      say 'Validating Mofa config (~/.mofa/config.yml)...'
-      say '- not implemented yet -'
-      true
-    end
-
     def self.exit_on_failure?
       true
     end

data/lib/mofa/cmd_line_args.rb

@@ -0,0 +1,25 @@
+module Mofa
+  class CmdLineArgs
+    def self.instance
+      @__instance__ ||= new
+    end
+
+    def initialize
+      @cmd_line_args = {}
+    end
+
+    def register(cmd_line_args)
+      @cmd_line_args = cmd_line_args
+    end
+
+    def get(key)
+      raise "Cmd Line Arg with key #{key} does not exist!" unless @cmd_line_args.key?(key)
+      @cmd_line_args[key]
+    end
+
+    def list
+    puts 'Comman Line Args:'
+    @cmd_line_args.inspect
+    end
+  end
+end

data/lib/mofa/mofa_cmd.rb

@@ -21,7 +21,7 @@ class MofaCmd
   end
 
   # @abstract
-  def execute
+  def execute(_ssh_port)
     raise RuntimeError, "must be implemented"
   end
 

data/lib/mofa/provision_cmd.rb

@@ -14,7 +14,7 @@ class ProvisionCmd < MofaCmd
     cookbook.prepare
   end
 
-  def execute
+  def execute(ssh_port, ssh_user, ssh_keyfile)
     cookbook.execute
 
     hostlist.retrieve
@@ -30,7 +30,7 @@ class ProvisionCmd < MofaCmd
 
     puts "Hostlist after runlist filtering: #{hostlist.list.inspect}"
 
-    exit_code = run_chef_solo_on_hosts
+    exit_code = run_chef_solo_on_hosts(ssh_port, ssh_user, ssh_keyfile)
 
     exit_code
   end
@@ -56,12 +56,12 @@ class ProvisionCmd < MofaCmd
     host_available
   end
 
-  def prepare_host(hostname, host_index, solo_dir)
+  def prepare_host(hostname, host_index, solo_dir, ssh_port, ssh_user, ssh_keyfile)
     puts
     puts '----------------------------------------------------------------------'
     puts "Chef-Solo on Host #{hostname} (#{host_index}/#{hostlist.list.length})"
     puts '----------------------------------------------------------------------'
-    Net::SSH.start(hostname, Mofa::Config.config['ssh_user'], keys: [Mofa::Config.config['ssh_keyfile']], port: Mofa::Config.config['ssh_port'], use_agent: false, verbose: :error) do |ssh|
+    Net::SSH.start(hostname, ssh_user, keys: [ssh_keyfile], port: ssh_port, use_agent: false, verbose: :error) do |ssh|
       puts "Remotely creating solo_dir \"#{solo_dir}\" on host #{hostname}"
       # remotely create the temp folder
       out = ssh_exec!(ssh, "[ -d #{solo_dir} ] || mkdir #{solo_dir}")
@@ -90,8 +90,6 @@ class ProvisionCmd < MofaCmd
       file.write(solo_rb)
     end
   end
-# log_level :info
-# log_location "#{solo_dir}/log"
 
   def create_node_json(sftp, hostname, solo_dir, attributes_map)
     puts "Remotely creating \"#{solo_dir}/node.json\" on #{hostname}..."
@@ -121,13 +119,13 @@ class ProvisionCmd < MofaCmd
     end
   end
 
-  def run_chef_solo_on_hosts
+  def run_chef_solo_on_hosts(ssh_port, ssh_user, ssh_keyfile)
     time = Time.new
     # Create a temp working dir on the target host
     solo_dir = '/var/tmp/' + time.strftime('%Y-%m-%d_%H%M%S')
     puts
     puts 'Chef-Solo Run started at ' + time.strftime('%Y-%m-%d %H:%M:%S')
-    puts "Will use ssh_user #{Mofa::Config.config['ssh_user']}, ssh_port #{Mofa::Config.config['ssh_port']} and ssh_key_file #{Mofa::Config.config['ssh_keyfile']}"
+    puts "Will use ssh_user '#{ssh_user}', ssh_port '#{ssh_port}' and ssh_keyfile '#{ssh_keyfile}'"
     at_least_one_chef_solo_run_failed = false
     chef_solo_runs = {}
     host_index = 0
@@ -144,9 +142,9 @@ class ProvisionCmd < MofaCmd
         end
       end
 
-      prepare_host(hostname, host_index, solo_dir)
+      prepare_host(hostname, host_index, solo_dir, ssh_port, ssh_user, ssh_keyfile)
 
-      Net::SFTP.start(hostname, Mofa::Config.config['ssh_user'], keys: [Mofa::Config.config['ssh_keyfile']], port: Mofa::Config.config['ssh_port'], use_agent: false, verbose: :error) do |sftp|
+      Net::SFTP.start(hostname, ssh_user, keys: [ssh_keyfile], port: ssh_port, use_agent: false, verbose: :error) do |sftp|
         # remotely creating solo.rb
         create_solo_rb(sftp, hostname, solo_dir)
 
@@ -164,7 +162,7 @@ class ProvisionCmd < MofaCmd
           # Do it -> Execute the chef-solo run!
           begin
             begin
-              Net::SSH.start(hostname, Mofa::Config.config['ssh_user'], keys: [Mofa::Config.config['ssh_keyfile']], port: Mofa::Config.config['ssh_port'], use_agent: false, verbose: :error) do |ssh|
+              Net::SSH.start(hostname, ssh_user, keys: [ssh_keyfile], port: ssh_port, use_agent: false, verbose: :error) do |ssh|
                 puts "Remotely unpacking Cookbook Package #{cookbook.pkg_name}... "
                 ssh.exec!("cd #{solo_dir}; tar xvfz #{cookbook.pkg_name}") do |_ch, _stream, line|
                   puts line if Mofa::CLI.option_debug
@@ -181,13 +179,13 @@ class ProvisionCmd < MofaCmd
               raise e
             end
             begin
-              Net::SSH.start(hostname, Mofa::Config.config['ssh_user'], keys: [Mofa::Config.config['ssh_keyfile']], port: Mofa::Config.config['ssh_port'], use_agent: false, verbose: :error) do |ssh|
+              Net::SSH.start(hostname, ssh_user, keys: [ssh_keyfile], port: ssh_port, use_agent: false, verbose: :error) do |ssh|
                 puts "Remotely running chef-solo -c #{solo_dir}/solo.rb -j #{solo_dir}/node.json"
                 chef_run_exit_code = 0
                 ssh.exec!("sudo chef-solo -c #{solo_dir}/solo.rb -j #{solo_dir}/node.json") do |_ch, _stream, line|
                   puts line if Mofa::CLI.option_verbose || Mofa::CLI.option_debug
                   log_file.write(line)
-                  chef_run_exit_code = 1 if line =~ /Chef run process exited unsuccessfully/
+                  chef_run_exit_code = 1 if line =~ /Chef run process exited unsuccessfully/ || line =~ /chef-solo: command not found/
                 end
                 raise 'Chef run process exited unsuccessfully' if chef_run_exit_code != 0
                 chef_solo_runs[hostname].store('status', 'SUCCESS')
@@ -207,7 +205,7 @@ class ProvisionCmd < MofaCmd
             log_file.write('chef-solo run: FAIL')
             puts "ERRORS detected while provisioning #{hostname} (#{e.message})."
           end
-          Net::SSH.start(hostname, Mofa::Config.config['ssh_user'], keys: [Mofa::Config.config['ssh_keyfile']], port: Mofa::Config.config['ssh_port'], use_agent: false, verbose: :error) do |ssh|
+          Net::SSH.start(hostname, ssh_user, keys: [ssh_keyfile], port: ssh_port, use_agent: false, verbose: :error) do |ssh|
             snapshot_or_release = cookbook.is_a?(SourceCookbook) ? 'snapshot' : 'release'
             out = ssh_exec!(ssh, "sudo chown -R #{Mofa::Config.config['ssh_user']}.#{Mofa::Config.config['ssh_user']} #{solo_dir}")
             puts "ERROR (#{out[0]}): #{out[2]}" if out[0] != 0

data/lib/mofa/released_cookbook.rb

@@ -26,11 +26,11 @@ class ReleasedCookbook < Cookbook
 
   def prepare
     @pkg_name ||= "#{name}_#{version}-full.tar.gz"
-    @pkg_dir = "#{Mofa::Config.config['tmp_dir']}/.mofa/#{token}"
+    @pkg_dir = "#{Mofa::CLI::option_tmp_dir}/.mofa/#{token}"
     set_cookbooks_url
   end
 
-  def execute#
+  def execute
     package
   end
 
@@ -65,16 +65,20 @@ class ReleasedCookbook < Cookbook
 
     # Sync in mofa_secrets
     if override_mofa_secrets
-      if File.directory?("#{override_mofa_secrets}/#{name}/cookbooks")
-        run "rsync -vr #{override_mofa_secrets}/#{name}/cookbooks/ #{pkg_dir}/tmp/cookbooks/"
-        if File.file?("#{override_mofa_secrets}/#{name}/.mofa.local.yml")
-          FileUtils.cp "#{override_mofa_secrets}/#{name}/.mofa.local.yml", "#{pkg_dir}/tmp/cookbooks/#{name}/"
-        end
-        if File.file?("#{override_mofa_secrets}/#{name}/.mofa.yml")
-          FileUtils.cp "#{override_mofa_secrets}/#{name}/.mofa.yml", "#{pkg_dir}/tmp/cookbooks/#{name}/"
+      if File.directory?("#{override_mofa_secrets}/#{name}")
+        if File.directory?("#{override_mofa_secrets}/#{name}/cookbooks")
+          run "rsync -vr #{override_mofa_secrets}/#{name}/cookbooks/ #{pkg_dir}/tmp/cookbooks/"
+          if File.file?("#{override_mofa_secrets}/#{name}/.mofa.local.yml")
+            FileUtils.cp "#{override_mofa_secrets}/#{name}/.mofa.local.yml", "#{pkg_dir}/tmp/cookbooks/#{name}/"
+          end
+          if File.file?("#{override_mofa_secrets}/#{name}/.mofa.yml")
+            FileUtils.cp "#{override_mofa_secrets}/#{name}/.mofa.yml", "#{pkg_dir}/tmp/cookbooks/#{name}/"
+          end
+        else
+          run "rsync -vr #{override_mofa_secrets}/#{name}/ #{pkg_dir}/tmp/cookbooks/#{name}/"
         end
       else
-        run "rsync -vr #{override_mofa_secrets}/#{name}/ #{pkg_dir}/tmp/cookbooks/#{name}/"
+        say "Skipping non-existant mofa-secrets folder #{override_mofa_secrets}/#{name}"
       end
     end
 
@@ -110,11 +114,11 @@ class ReleasedCookbook < Cookbook
   end
 
   def cleanup!
-    unless (Dir.entries("#{Mofa::Config.config['tmp_dir']}/.mofa") - %w{ . .. }).empty?
-      say "Removing content of folder #{Mofa::Config.config['tmp_dir']}/.mofa"
-      run "rm -r #{Mofa::Config.config['tmp_dir']}/.mofa/*"
+    unless (Dir.entries("#{Mofa::CLI::option_tmp_dir}/.mofa") - %w{ . .. }).empty?
+      say "Removing content of folder #{Mofa::CLI::option_tmp_dir}/.mofa"
+      run "rm -r #{Mofa::CLI::option_tmp_dir}/.mofa/*"
     else
-      say "Folder #{Mofa::Config.config['tmp_dir']}/.mofa is (already) clean."
+      say "Folder #{Mofa::CLI::option_tmp_dir}/.mofa is (already) clean."
     end
   end
 

data/lib/mofa/source_cookbook.rb

@@ -77,11 +77,11 @@ class SourceCookbook < Cookbook
   end
 
   def cleanup!
-    unless (Dir.entries("#{Mofa::Config.config['tmp_dir']}/.mofa") - %w{ . .. }).empty?
-      say "Removing content of folder #{Mofa::Config.config['tmp_dir']}/.mofa"
-      run "rm -r #{Mofa::Config.config['tmp_dir']}/.mofa/*"
+    unless (Dir.entries("#{Mofa::CLI::option_tmp_dir}/.mofa") - %w{ . .. }).empty?
+      say "Removing content of folder #{Mofa::CLI::option_tmp_dir}/.mofa"
+      run "rm -r #{Mofa::CLI::option_tmp_dir}/.mofa/*"
     else
-      say "Folder #{Mofa::Config.config['tmp_dir']}/.mofa is (already) clean."
+      say "Folder #{Mofa::CLI::option_tmp_dir}/.mofa is (already) clean."
     end
   end
 

data/lib/mofa/upload_cmd.rb

@@ -15,7 +15,7 @@ class UploadCmd < MofaCmd
     cookbook.prepare
   end
 
-  def execute
+  def execute(_ssh_port)
     cookbook.execute
     upload_cookbook_pkg
   end

data/lib/mofa/version.rb

@@ -1,3 +1,3 @@
 module Mofa
-  VERSION = '0.5.5'
+  VERSION = '0.5.12'
 end

data/mofa.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "guard-minitest"
   s.add_development_dependency "rake"
   s.add_runtime_dependency "thor"
+  # s.add_runtime_dependency "ed25519"
+  # s.add_runtime_dependency "bcrypt_pbkdf"
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "rest-client"
   s.add_runtime_dependency "net-ssh"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mofa
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.12
 platform: ruby
 authors:
 - Alexander Birk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -202,17 +202,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/mofa
+- config.docker.yml
 - config.yml.erb
 - lib/mofa.rb
 - lib/mofa/attributes_map.rb
 - lib/mofa/cli.rb
+- lib/mofa/cmd_line_args.rb
 - lib/mofa/config.rb
 - lib/mofa/cookbook.rb
 - lib/mofa/hostlist.rb
@@ -230,7 +234,7 @@ files:
 homepage: https://github.com/pingworks/mofa
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -245,9 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mofa
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: a lightweight remote chef-solo runner
 test_files: []