gitlab_support_readiness 1.0.11 → 1.0.12

data/lib/support_readiness/repos/automations.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Repos
+  module Repos
+    ##
+    # Defines the class Automations within the module {Readiness::Repos}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Automations < Readiness::Client
+      ##
+      # Compares the repo automation files to the Zendesk instance automations
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param zendesk_client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @param verbose [Boolean] Whether you want a detailed report or not
+      # @return [Hash]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Automations.compare(client, 'automations/data', false)
+      #   pp diffs[:updates.count]
+      #   # => 5
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Automations.compare(client, 'automations/data', true)
+      #   # => Detailed diff of Status::Close::Close solved tickets after 7 days
+      #   # => - @default Repo:
+      #   # => false
+      #   # =>   @default Zendesk:
+      #   # => true
+      #   # => Compare report:
+      #   # => - Creates: 0
+      #   # => - Updates: 1
+      #   pp diffs[:updates.count]
+      #   # => 1
+      def self.compare(zendesk_client, location = 'data', verbose = false)
+        diffs = {
+          updates: [],
+          creates: []
+        }
+        from_repo = gather(location)
+        from_zendesk = Zendesk::Automations.list(zendesk_client)
+        from_repo.each do |repo|
+          zd = from_zendesk.detect { |z| z.title == repo.title }
+          if zd.nil?
+            diffs[:creates].push(repo)
+          else
+            comparable = zd.dup
+            comparable.id = nil
+            diffs[:updates].push(update_object(repo, zd)) if to_clean_json(repo) != to_clean_json(comparable)
+            detailed_diff(repo, comparable) if verbose && to_clean_json(repo) != to_clean_json(comparable)
+          end
+        end
+        report_diffs(diffs) if verbose
+        diffs
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param diffs [Hash] The returned value of {compare}
+      def self.report_diffs(diffs)
+        puts 'Compare report:'
+        puts "- Creates: #{diffs[:creates].count}"
+        puts "- Updates: #{diffs[:updates].count}"
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Automations}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Automations}
+      def self.detailed_diff(repo, zendesk)
+        puts "Detailed diff of #{repo.title}"
+        repo.instance_variables.each do |v|
+          next if v == :@id
+
+          if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
+            puts "- #{v} Repo:"
+            pp repo.instance_variable_get(v)
+            puts "  #{v} Zendesk:"
+            pp zendesk.instance_variable_get(v)
+          end
+        end
+      end
+
+      ##
+      # Creates an instance of {Readiness::Zendesk::Automations} to use for updates
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Automations}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Automations}
+      # @return [Object]
+      def self.update_object(repo, zendesk)
+        object = repo
+        object.id = zendesk.id
+        object
+      end
+
+      ##
+      # Parses repo automation files
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @return [Array]
+      # @example
+      #   require 'support_readiness'
+      #   repo = Readiness::Repos::Automations.gather('automations/data')
+      #   pp repo.count
+      #   # => 35
+      def self.gather(location = 'data')
+        @errors = []
+        @location = location
+        array = []
+        Dir["#{@location}/**/*.yaml"].each do |f|
+          object = YAML.safe_load_file(f)
+          object = convert_managed_content(object) if object['contains_managed_content']
+          object = convert_managed_webhook(object) if object['contains_managed_webhook']
+          validity_check(f, object)
+          object['id'] = nil
+          array.push(Zendesk::Automations.new(object))
+        end
+        repo_check(array)
+        report_errors unless @errors.count.zero?
+        array
+      end
+
+      ##
+      # Outputs an error report and exits with a status code of 1
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      def self.report_errors
+        puts 'The following errors were found in the repo files:'
+        @errors.each do |e|
+          puts "- #{e}"
+        end
+        puts 'Rectify the errors and retry. We cannot proceed with those errors occurring.'
+        exit 1
+      end
+
+      ##
+      # Performs basic checks on a repo file
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param file [String] The path to the repo file
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.validity_check(file, object)
+        folder = file.split("#{@location}/").last.split('/').first
+        @errors.push("Missing position: #{file}") if object['position'].nil?
+        @errors.push("Missing title: #{file}") if object['title'].nil?
+        @errors.push("Inactive automation in active folder: #{file}") if folder == 'active' && !object['active']
+        @errors.push("Active automation in inactive folder: #{file}") if folder == 'inactive' && object['active']
+      end
+
+      ##
+      # Performs basic checks on the repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param objects [Array] The Array of Hashes derived from parsing the repo files
+      def self.repo_check(objects)
+        duplicate_names = objects.group_by { |o| o.title }.select { |k, v| v.size > 1 }.map(&:first)
+        unless duplicate_names.count.zero?
+          duplicate_names.each do |d|
+            @errors.push("The title '#{d}' is used in multiple files")
+          end
+        end
+      end
+
+      ##
+      # Performs conversions for a repo file if using managed content
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.convert_managed_content(object)
+        path = "#{@location}/managed_content/#{object['title']}.md"
+        handle_request_error(1, 'Repos', 404, { action: 'Get managed content', id: object['title'] }) unless File.exist?(path)
+        object['actions'].each_with_index do |action, index|
+          if action['value'].is_a?(String)
+            if action['value'] =~ /MANAGED_CONTENT/
+              if action['value'] == 'MANAGED_CONTENT'
+                object['actions'][index]['value'] = action['value'].gsub('MANAGED_CONTENT', File.read(path).chomp)
+              else
+                object['actions'][index]['value'] = action['value'].gsub('MANAGED_CONTENT', File.read(path).chomp.gsub("\n", '\\n'))
+              end
+            end
+          elsif action['value'].is_a?(Array)
+            action['value'].each_with_index do |value, sub_index|
+              if value =~ /MANAGED_CONTENT/
+                if value == 'MANAGED_CONTENT'
+                  object['actions'][index]['value'][sub_index] = value.gsub('MANAGED_CONTENT', File.read(path).chomp)
+                else
+                  object['actions'][index]['value'][sub_index] = value.gsub('MANAGED_CONTENT', File.read(path).chomp.gsub("\n", '\\n'))
+                end
+              end
+            end
+          end
+        end
+        object
+      end
+
+      ##
+      # Performs conversions for a repo file if using managed webhooks
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.convert_managed_webhook(object)
+        path = "#{@location}/managed_content/#{object['title']}.webhook"
+        handle_request_error(1, 'Repos', 404, { action: 'Get managed webhook', id: object['title'] }) unless File.exist?(path)
+        object['actions'].each_with_index do |action, index|
+          next unless action['value'].is_a?(Array)
+
+          action['value'].each_with_index do |value, sub_index|
+            next unless value == 'MANAGED_WEBHOOK'
+
+            object['actions'][index]['value'][sub_index] = JSON.parse(File.read(path))
+          end
+        end
+        object
+      end
+    end
+  end
+end

data/lib/support_readiness/repos/groups.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Repos
+  module Repos
+    ##
+    # Defines the class Groups within the module {Readiness::Repos}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Groups < Readiness::Client
+      ##
+      # Compares the repo automation files to the Zendesk instance groups
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param zendesk_client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @param verbose [Boolean] Whether you want a detailed report or not
+      # @return [Hash]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Groups.compare(client, 'groups/data', false)
+      #   pp diffs[:updates.count]
+      #   # => 1
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Groups.compare(client, 'groups/data', true)
+      #   # => Detailed diff of Support Ops
+      #   # => - @description Repo:
+      #   # => "For GitLab Support Operations"
+      #   # =>   @description Zendesk:
+      #   # => "For GitLab Support Ops"
+      #   # => Compare report:
+      #   # => - Creates: 0
+      #   # => - Updates: 1
+      #   pp diffs[:updates.count]
+      #   # => 1
+      def self.compare(zendesk_client, location = 'data', verbose = false)
+        diffs = {
+          updates: [],
+          creates: []
+        }
+        from_repo = gather(location)
+        from_zendesk = Zendesk::Groups.list(zendesk_client)
+        from_repo.each do |repo|
+          zd = from_zendesk.detect { |z| z.name == repo.name }
+          if zd.nil?
+            diffs[:creates].push(repo)
+          else
+            comparable = zd.dup
+            comparable.id = nil
+            diffs[:updates].push(update_object(repo, zd)) if to_clean_json(repo) != to_clean_json(comparable)
+            detailed_diff(repo, comparable) if verbose && to_clean_json(repo) != to_clean_json(comparable)
+          end
+        end
+        report_diffs(diffs) if verbose
+        diffs
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param diffs [Hash] The returned value of {compare}
+      def self.report_diffs(diffs)
+        puts 'Compare report:'
+        puts "- Creates: #{diffs[:creates].count}"
+        puts "- Updates: #{diffs[:updates].count}"
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Groups}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Groups}
+      def self.detailed_diff(repo, zendesk)
+        puts "Detailed diff of #{repo.title}"
+        repo.instance_variables.each do |v|
+          next if v == :@id
+
+          if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
+            puts "- #{v} Repo:"
+            pp repo.instance_variable_get(v)
+            puts "  #{v} Zendesk:"
+            pp zendesk.instance_variable_get(v)
+          end
+        end
+      end
+
+      ##
+      # Creates an instance of {Readiness::Zendesk::Groups} to use for updates
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Groups}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Groups}
+      # @return [Object]
+      def self.update_object(repo, zendesk)
+        object = repo
+        object.id = zendesk.id
+        object
+      end
+
+      ##
+      # Parses repo group files
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @return [Array]
+      # @example
+      #   require 'support_readiness'
+      #   repo = Readiness::Repos::Groups.gather('groups/data')
+      #   pp repo.count
+      #   # => 35
+      def self.gather(location = 'data')
+        @errors = []
+        @location = location
+        array = []
+        Dir["#{@location}/*.yaml"].each do |f|
+          object = YAML.safe_load_file(f)
+          validity_check(f, object)
+          object['id'] = nil
+          array.push(Zendesk::Groups.new(object))
+        end
+        repo_check(array)
+        report_errors unless @errors.count.zero?
+        array
+      end
+
+      ##
+      # Outputs an error report and exits with a status code of 1
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      def self.report_errors
+        puts 'The following errors were found in the repo files:'
+        @errors.each do |e|
+          puts "- #{e}"
+        end
+        puts 'Rectify the errors and retry. We cannot proceed with those errors occurring.'
+        exit 1
+      end
+
+      ##
+      # Performs basic checks on a repo file
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param file [String] The path to the repo file
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.validity_check(file, object)
+        @errors.push("Missing name: #{file}") if object['name'].nil?
+        @errors.push("Deleted group file: #{file}") if object['deleted']
+      end
+
+      ##
+      # Performs basic checks on the repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param objects [Array] The Array of Hashes derived from parsing the repo files
+      def self.repo_check(objects)
+        duplicate_names = objects.group_by { |o| o.name }.select { |k, v| v.size > 1 }.map(&:first)
+        unless duplicate_names.count.zero?
+          duplicate_names.each do |d|
+            @errors.push("The name '#{d}' is used in multiple files")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/support_readiness/repos/macros.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Repos
+  module Repos
+    ##
+    # Defines the class Macros within the module {Readiness::Repos}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Macros < Readiness::Client
+      ##
+      # Compares the repo automation files to the Zendesk instance macros
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param zendesk_client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @param verbose [Boolean] Whether you want a detailed report or not
+      # @return [Hash]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Macros.compare(client, 'macros/data', false)
+      #   pp diffs[:updates.count]
+      #   # => 5
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   diffs = Readiness::Repos::Macros.compare(client, 'macros/data', true)
+      #   # => Detailed diff of Status::Close::Close solved tickets after 7 days
+      #   # => - @default Repo:
+      #   # => false
+      #   # =>   @default Zendesk:
+      #   # => true
+      #   # => Compare report:
+      #   # => - Creates: 0
+      #   # => - Updates: 1
+      #   pp diffs[:updates.count]
+      #   # => 1
+      def self.compare(zendesk_client, location = 'data', verbose = false)
+        diffs = {
+          updates: [],
+          creates: []
+        }
+        from_repo = gather(location)
+        from_zendesk = Zendesk::Macros.list(zendesk_client)
+        from_repo.each do |repo|
+          zd = from_zendesk.detect { |z| z.title == repo.title }
+          if zd.nil?
+            diffs[:creates].push(repo)
+          else
+            comparable = zd.dup
+            comparable.id = nil
+            diffs[:updates].push(update_object(repo, zd)) if to_clean_json(repo) != to_clean_json(comparable)
+            detailed_diff(repo, comparable) if verbose && to_clean_json(repo) != to_clean_json(comparable)
+          end
+        end
+        report_diffs(diffs) if verbose
+        diffs
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param diffs [Hash] The returned value of {compare}
+      def self.report_diffs(diffs)
+        puts 'Compare report:'
+        puts "- Creates: #{diffs[:creates].count}"
+        puts "- Updates: #{diffs[:updates].count}"
+      end
+
+      ##
+      # Outputs a comparison report
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Macros}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Macros}
+      def self.detailed_diff(repo, zendesk)
+        puts "Detailed diff of #{repo.title}"
+        repo.instance_variables.each do |v|
+          next if v == :@id
+
+          if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
+            puts "- #{v} Repo:"
+            pp repo.instance_variable_get(v)
+            puts "  #{v} Zendesk:"
+            pp zendesk.instance_variable_get(v)
+          end
+        end
+      end
+
+      ##
+      # Creates an instance of {Readiness::Zendesk::Macros} to use for updates
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param repo [Object] An instance of {Readiness::Zendesk::Macros}
+      # @param zendesk [Object] An instance of {Readiness::Zendesk::Macros}
+      # @return [Object]
+      def self.update_object(repo, zendesk)
+        object = repo
+        object.id = zendesk.id
+        object
+      end
+
+      ##
+      # Parses repo macro files
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param location [String] The location (relative or absolute) of the repo's data folder
+      # @return [Array]
+      # @example
+      #   require 'support_readiness'
+      #   repo = Readiness::Repos::Macros.gather('macros/data')
+      #   pp repo.count
+      #   # => 35
+      def self.gather(location = 'data')
+        @errors = []
+        @location = location
+        array = []
+        Dir["#{@location}/**/*.yaml"].each do |f|
+          object = YAML.safe_load_file(f)
+          object = convert_managed_content(object) if object['contains_managed_content']
+          validity_check(f, object)
+          object['id'] = nil
+          array.push(Zendesk::Macros.new(object))
+        end
+        repo_check(array)
+        report_errors unless @errors.count.zero?
+        array
+      end
+
+      ##
+      # Outputs an error report and exits with a status code of 1
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      def self.report_errors
+        puts 'The following errors were found in the repo files:'
+        @errors.each do |e|
+          puts "- #{e}"
+        end
+        puts 'Rectify the errors and retry. We cannot proceed with those errors occurring.'
+        exit 1
+      end
+
+      ##
+      # Performs basic checks on a repo file
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param file [String] The path to the repo file
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.validity_check(file, object)
+        folder = file.split("#{@location}/").last.split('/').first
+        @errors.push("Missing title: #{file}") if object['title'].nil?
+        @errors.push("Inactive macro in active folder: #{file}") if folder == 'active' && !object['active']
+        @errors.push("Active macro in inactive folder: #{file}") if folder == 'inactive' && object['active']
+      end
+
+      ##
+      # Performs basic checks on the repo
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param objects [Array] The Array of Hashes derived from parsing the repo files
+      def self.repo_check(objects)
+        duplicate_names = objects.group_by { |o| o.title }.select { |k, v| v.size > 1 }.map(&:first)
+        unless duplicate_names.count.zero?
+          duplicate_names.each do |d|
+            @errors.push("The title '#{d}' is used in multiple files")
+          end
+        end
+      end
+
+      ##
+      # Performs conversions for a repo file if using managed content
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Hash] The Hash derived from parsing a YAML file
+      def self.convert_managed_content(object)
+        path = "#{@location}/managed_content/#{object['active'] ? '' : 'in'}active/#{object['title'].gsub('::', '/')}.md"
+        handle_request_error(1, 'Repos', 404, { action: 'Get managed content', id: object['title'] }) unless File.exist?(path)
+        object['actions'].each_with_index do |action, index|
+          if action['value'].is_a?(String)
+            if action['value'] =~ /MANAGED_CONTENT/
+              if action['value'] == 'MANAGED_CONTENT'
+                object['actions'][index]['value'] = action['value'].gsub('MANAGED_CONTENT', File.read(path).chomp)
+              else
+                object['actions'][index]['value'] = action['value'].gsub('MANAGED_CONTENT', File.read(path).chomp.gsub("\n", '\\n'))
+              end
+            end
+          elsif action['value'].is_a?(Array)
+            action['value'].each_with_index do |value, sub_index|
+              if value =~ /MANAGED_CONTENT/
+                if value == 'MANAGED_CONTENT'
+                  object['actions'][index]['value'][sub_index] = value.gsub('MANAGED_CONTENT', File.read(path).chomp)
+                else
+                  object['actions'][index]['value'][sub_index] = value.gsub('MANAGED_CONTENT', File.read(path).chomp.gsub("\n", '\\n'))
+                end
+              end
+            end
+          end
+        end
+        object
+      end
+    end
+  end
+end