shards 3.3 → 3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d1825ac3c373928a5d4a5df342e6c058fe305abd92686301bc7ea4549d1a74
-  data.tar.gz: e67a7dd5c45081123a4e866a852a3f65e4df6133eb23bf0693ef3e8f694dc945
+  metadata.gz: 320ece700811e52b39ec9fa674dcfd15931eda715e56a1feaf753737d80e2308
+  data.tar.gz: 87b7124eb6879b2f904842c6d07d641b2f070144fb2a73162d27072882b6341b
 SHA512:
-  metadata.gz: 12b2b37ca0fe4e0e4644b613c185a606f5cbebea4d8eb8b40b62c0571b7c14ae7696ab6087d84e68f0cfe366bd1ac2819591738c9fa44fb1ad4ea65a34ee6cf4
-  data.tar.gz: cbc4e93e6f2398e3b3af6ecff3d80bb37cfc7d889ad4478385d28264e903abb421e843e14fc654201e20dca19a7dd5b83ea7831bf441d01480819678f72eb2ef
+  metadata.gz: 601e021902dc07f7bcb031fd148d646c2f1e1cd1cc7c486db9bd6001b1255d5750632b3c19fab30805a1623c19126c61a8c0edf7e94148eaf6f278402d8b009d
+  data.tar.gz: 56e5b9760062b62ff658387685f5bbf16fc87231b102816c14b9c8a8059bf737708f80dbab577ddd8229ccf099735a9070fec8402732ead6a0d1c639a9de515a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shards (3.3)
+    shards (3.5)
       aws-sdk-ec2 (~> 1.48)
       aws-sdk-elasticloadbalancing (~> 1.5)
       aws-sdk-elasticloadbalancingv2 (~> 1.14)
@@ -30,7 +30,7 @@ GEM
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.70.0)
+    aws-sdk-ec2 (1.71.0)
       aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
     aws-sdk-elasticloadbalancing (1.8.0)

data/lib/settings/workflows/create_by_api.yaml

@@ -25,3 +25,6 @@ correct_steps_summary:
 
 
 start: validate_client
+description: >
+  This is the first workflow the shards application tool triggers when the *Site Creation* job.
+  After that will be executed the Fingerprint by API workflow.

data/lib/settings/workflows/delete_by_api.yaml

@@ -45,3 +45,6 @@ correct_steps_summary:
   - commit_changes
 
 start: validate_location
+description: >
+  This workflow is the first that the *Site Deletion* job runs in the shards service application.
+  Then the application will run the Reload by API workflow to run the puppet agent, check fingerprints, reload task and then delete the database.

data/lib/settings/workflows/delete_by_terminal.yaml

@@ -54,3 +54,4 @@ delete_by_terminal:
     wrong: finish
 
 start: validate_location
+description: This workflow is used by the shards gem command tool when the delete command is called.

data/lib/settings/workflows/fast_terminal.yaml

@@ -29,3 +29,4 @@ correct_steps_summary:
   - dns_upsert
 
 start: validate_client
+description: It is used by the shards command tool to create new sites and shards.

data/lib/settings/workflows/fast_terminal_two.yaml

@@ -26,3 +26,6 @@ correct_steps_summary:
   - dns_upsert
 
 start: validate_client
+description: >
+  It is the same as Fast Terminal without the loop ( fingerprint check, puppet agent ) and the reload shards task.
+

data/lib/settings/workflows/fingerprints_by_api.yaml

@@ -46,3 +46,9 @@ correct_steps_summary:
   - dns_upsert
 
 start: validate_client
+description: >
+  This is the second workflow that the *Site Creation* job call after the Create By API.
+  The application run this workflow in a loop.
+  When the fingerprints don't match the puppet agent will be executed in order to update the shards and sites yml files.
+  The loop finish when the fingerprints are the same.
+  Then run the application reload shard task to upgrade the shards and sites data.

data/lib/settings/workflows/fingerprints_terminal.yaml

@@ -40,3 +40,7 @@ correct_steps_summary:
   - dns_upsert
 
 start: validate_client
+description: |
+  This workflow is used by the shards gem command tool in the check_fingerprints command.
+  It will run the puppet agent in a loop when the fingerprints don't match.
+  Once the fingerprints match continue with reload shards task and a dns uspsert.

data/lib/settings/workflows/fingerprints_terminal_two.yaml

@@ -30,3 +30,4 @@ correct_steps_summary:
   - application_reload_shards_task
 
 start: validate_location
+description: The same as the finerprints_terminal without dns_uspert.

data/lib/settings/workflows/reload_by_api.yaml

@@ -52,3 +52,7 @@ correct_steps_summary:
   - delete_database
 
 start: validate_client
+description: |
+  This workflow will be executed after the *delete by api* worflow in the *Site Deletion* job.
+  When the fingerprints match the application reload task will be executed.
+  The final step is delete the database.

data/lib/shards/client.rb

@@ -230,6 +230,30 @@ module Shards
       puts s.check_remote_process remote_check: :reload_shards!
 
     end
+
+    desc "workflows", "Show the workflow list"
+
+    def workflows
+      Dotenv.load 'settings.env'
+      settings_files= Dir.entries(ENV['WORKFLOW_YAML_PATH']).reject { |x| %w(. .. base.yaml).include?x }.sort
+      puts settings_files.map { |x| x.chomp '.yaml' }
+    end
+
+    desc "workflow_steps", "Print the workflow steps"
+    option :name, required: true, desc: "workflow name"
+
+    def workflow_steps
+
+      name=options[:name].split('_').map { |x| x.capitalize }.join
+
+      wf=Kernel.const_get("Shards::Workflow::#{name}").new config
+
+      wf.print_description
+      wf.print_step
+      wf.print_extra_steps
+
+    end
+
     private
 
     def config

data/lib/shards/version.rb

@@ -1,3 +1,3 @@
 module Shards
-  VERSION = "3.3"
+  VERSION = "3.5"
 end

data/lib/shards/workflow/base.rb

@@ -66,14 +66,18 @@ module Shards
           gsub(/\s/, '_').downcase
       end
 
-      def start
+      def flow_init
         @flow=shared_steps.merge yaml[wf]
+      end
+
+      def start
+        flow_init
         @pointer=yaml['start']
         run_step
       end
 
       def start_at pointer_step
-        @flow=shared_steps.merge yaml[wf]
+        flow_init
         @pointer=pointer_step
         run_step
       end
@@ -98,6 +102,81 @@ module Shards
 
       end
 
+      def correct_steps
+        @correct_steps||={}
+      end
+
+      def wrong_steps
+        @wrong_steps||={}
+      end
+
+      def print_step
+
+        if pointer.nil?
+          flow_init
+          @pointer=yaml['start']
+          puts "h2. Step List"
+        end
+
+        @step=flow[pointer]
+        @pointer_history << pointer
+
+        puts_step pointer, step
+
+        correct_steps[step['correct']]=flow[step['correct']]
+        wrong_steps[step['wrong']]=flow[step['wrong']] unless step['wrong'].nil?
+        @pointer=step['correct']
+        print_step if @step['correct']!='final_step'
+
+      end
+
+      def wf_title
+        wf.split('_').map { |x| x.capitalize }.join(' ')
+      end
+
+      def print_description
+        puts "h1. #{wf_title}"
+        puts yaml['description'] if yaml.has_key?('description')
+      end
+
+      def puts_step pointer, step
+
+        puts "|| #{pointer} "
+        puts " - Correct => #{step['correct']}" if step.has_key?('correct')
+        puts " - Wrong => #{step['wrong']}" if step.has_key?('wrong')
+        puts "|"
+        puts
+
+      end
+
+      def print_extra_steps
+        (wrong_steps.keys & correct_steps.keys).each { |k| wrong_steps.delete k }
+
+        loop do
+          initial_keys=wrong_steps.keys + correct_steps.keys
+          new_keys=[]
+
+          wrong_steps.each_pair do |k,v|
+            new_keys << v['correct'] if v.has_key?('correct') and !initial_keys.include?v['correct']
+            new_keys << v['wrong'] if v.has_key?('wrong') and !initial_keys.include?v['wrong']
+          end
+          if new_keys.empty?
+            break
+          else
+            new_keys.each do |k|
+              wrong_steps[k]=flow[k]
+            end
+          end
+        end
+
+        puts "h2. Additional Steps:" unless wrong_steps.empty?
+
+        wrong_steps.each_pair do |k,v|
+          puts_step k, v
+        end
+
+      end
+
       def output_message message
         puts message
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shards
 version: !ruby/object:Gem::Version
-  version: '3.3'
+  version: '3.5'
 platform: ruby
 authors:
 - Diego PL
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler