satorix 0.0.1 → 1.6.0

data/lib/satorix/CI/shared/yarn_manager.rb

@@ -0,0 +1,22 @@
+module Satorix
+  module CI
+    module Shared
+
+      module YarnManager
+
+        include Satorix::Shared::Console
+
+        extend self
+
+
+        def go
+          log_bench('Installing yarn dependencies...') { run_command(%w[yarn install]) }
+        end
+
+
+        private
+
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/python/django_test.rb

@@ -0,0 +1,35 @@
+module Satorix
+  module CI
+    module Test
+      module Python
+        module DjangoTest
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Python version...') { run_command(%w[python --version]) }
+            log_bench('Running tests...') { run_tests }
+          end
+
+
+          def run_tests
+            run_command([manage, 'collectstatic'])
+            run_command([manage, 'test', 'public'])
+          end
+
+
+          private
+
+
+            def manage
+              File.join(Satorix.app_dir, 'public', 'manage.py')
+            end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/python/safety.rb

@@ -0,0 +1,27 @@
+module Satorix
+  module CI
+    module Test
+      module Python
+        module Safety
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Python version...') { run_command(%w[python --version]) }
+            log_bench('Installing Safety...') { run_command(%w[pip install safety]) }
+            log_bench('Auditing requirements.txt...') { run_scan }
+          end
+
+
+          def run_scan
+            run_command(%w[safety check -r requirements.txt])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/brakeman.rb

@@ -0,0 +1,32 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module Brakeman
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Installing Brakeman...') { install_gem }
+            log_bench('Running Brakeman scan...') { run_scan }
+          end
+
+
+          def install_gem
+            run_command(['gem', 'install', 'brakeman', '--no-document', '--bindir', Satorix.bin_dir])
+          end
+
+
+          def run_scan
+            run_command(['brakeman', '-z', '--table-width', '1200', '--exit-on-error', '--path', Satorix.app_dir])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/bundler_audit.rb

@@ -0,0 +1,32 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module BundlerAudit
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Installing bundler-audit...') { install_gem }
+            log_bench('Auditing Gemfile.lock...') { run_scan }
+          end
+
+
+          def install_gem
+            run_command(['gem', 'install', 'bundler-audit', '--no-document', '--bindir', Satorix.bin_dir])
+          end
+
+
+          def run_scan
+            run_command(%w[bundle-audit check --update])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/cucumber.rb

@@ -0,0 +1,26 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module Cucumber
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Running Cucumber...') { run_cucumber }
+          end
+
+
+          def run_cucumber
+            run_command(%w[bundle exec cucumber])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/rails_test.rb

@@ -0,0 +1,26 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module RailsTest
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Running Rails test...') { run_scan }
+          end
+
+
+          def run_scan
+            run_command(%w[rails test])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/rspec.rb

@@ -0,0 +1,26 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module Rspec
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Running specs...') { run_specs }
+          end
+
+
+          def run_specs
+            run_command(%w[rspec spec])
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/ruby/rubocop.rb

@@ -0,0 +1,98 @@
+module Satorix
+  module CI
+    module Test
+      module Ruby
+        module Rubocop
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go
+            log_bench('Displaying current Ruby version...') { run_command(%w[ruby -v]) }
+            log_bench('Installing Rubocop...') { install_gems }
+            log_bench('Configuring Rubocop...') { create_rubocop_config }
+            log_bench('Running Rubocop inspection...') { run_scan }
+          end
+
+
+          def install_gems
+            run_command(['gem', 'install', 'rubocop', '--no-document', '--bindir', Satorix.bin_dir])
+            run_command(['gem', 'install', 'rubocop-performance', '--no-document', '--bindir', Satorix.bin_dir])
+            run_command(['gem', 'install', 'rubocop-rails_config', '--no-document', '--bindir', Satorix.bin_dir]) if Satorix.rails_app?
+          end
+
+
+          def create_rubocop_config
+            if config_exist?
+              log 'Using existing .rubocop.yml file from project.'
+            else
+              log 'A .rubocop.yml file was not found, generating a default configuration file for this project.'
+              content = Satorix.rails_app? ? config_content_rails : config_content_default
+              save_rubocop_config content
+            end
+            log 'For more information, please refer to https://www.satorix.com/docs/articles/app_using_ruby_on_rails#rubocop.'
+          end
+
+
+          def run_scan
+            command = %w[rubocop --require rubocop-performance --display-cop-names --extra-details --display-style-guide --parallel]
+            command.concat(%w[--require rubocop-rails]) if Satorix.rails_app?
+
+            run_command(command)
+          end
+
+
+          private
+
+
+            def rubocop_config_file
+              File.join(Satorix.app_dir, '.rubocop.yml')
+            end
+
+
+            def save_rubocop_config(config)
+              File.open(rubocop_config_file, 'w') { |f| f.write(config) }
+            end
+
+
+            def config_exist?
+              File.exist? rubocop_config_file
+            end
+
+
+            def ruby_version
+              version = run_command(%w[bundle platform --ruby], quiet: true)
+              version.match(/\d+\.\d+\.\d+/)[0]
+            end
+
+
+            def config_content_default
+              <<~CONTENT
+                AllCops:
+                  TargetRubyVersion: #{ ruby_version }
+                  Exclude:
+                    - '**/tmp/**/*'
+                    - '**/templates/**/*'
+                    - '**/vendor/**/*'
+              CONTENT
+            end
+
+
+            def config_content_rails
+              <<~CONTENT
+                inherit_gem:
+                  rubocop-rails_config:
+                    - config/rails.yml
+
+                AllCops:
+                  TargetRubyVersion: #{ ruby_version }
+              CONTENT
+            end
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/CI/test/shared/database.rb

@@ -0,0 +1,74 @@
+module Satorix
+  module CI
+    module Test
+      module Shared
+        module Database
+
+
+          include Satorix::Shared::Console
+
+
+          extend self
+
+
+          def host
+            ENV['DB_HOST'].to_s
+          end
+
+
+          def name
+            name_key.empty? ? '' : ENV[name_key].to_s
+          end
+
+
+          def name_key
+            {
+              mariadb: 'MYSQL_DATABASE',
+              mysql: 'MYSQL_DATABASE',
+              postgres: 'POSTGRES_DB'
+            }[host.to_sym].to_s
+          end
+
+
+          def password
+            password_key.empty? ? '' : ENV[password_key].to_s
+          end
+
+
+          def password_key
+            {
+              mariadb: 'MYSQL_ROOT_PASSWORD',
+              mysql: 'MYSQL_ROOT_PASSWORD',
+              postgres: 'POSTGRES_PASSWORD'
+            }[host.to_sym].to_s
+          end
+
+
+          def url
+            unset = [host, user, password, name].select(&:empty?)
+            if unset.empty?
+              "#{ host }://#{ user }:#{ password }@#{ host }/#{ name }"
+            else
+              log 'No database has been configured.'
+              log 'If you would like to use a database for this job, ensure that your gitlab-config.yml is configured.'
+              log 'Most databases require you to specify a type, host, database, username, and password.'
+              nil
+            end
+          end
+
+
+          def user
+            (ENV[user_key] || 'root').to_s
+          end
+
+
+          def user_key
+            "#{ host.upcase }_USER"
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/satorix/shared/console.rb

@@ -0,0 +1,180 @@
+module Satorix
+  module Shared
+    module Console
+
+      require 'benchmark'
+      require 'English' # http://ruby-doc.org/stdlib-2.0.0/libdoc/English/rdoc/English.html
+      require 'shellwords'
+
+      extend self
+
+
+      def colorize(text, color = nil)
+        "\033[#{ colors[color] }m#{ text }\033[0m"
+      end
+
+
+      def colors
+        Hash.new(39).merge(red: '0;31', light_red: '1;31',
+                           green: '0;32', light_green: '1;32',
+                           yellow: '0;33', light_yellow: '1;33',
+                           blue: '0;34', light_blue: '1;34',
+                           magenta: '0;35', light_magenta: '1;35',
+                           cyan: '0;36', light_cyan: '1;36',
+                           white: '0;37', light_white: '1;37')
+      end
+
+
+      def humanize_time(seconds)
+        return 'less than 1 second' if seconds < 1
+        [[60, :second], [60, :minute], [24, :hour], [1000, :day]].map do |count, name|
+          if seconds > 0
+            seconds, n = seconds.divmod(count)
+            n = n.to_i
+            "#{ n } #{ name }#{ 's' if n > 1 }" if n > 0
+          end
+        end.compact.reverse.join(' ')
+      end
+
+
+      def log(text, color = nil)
+        puts color ? colorize(text, color) : text
+      end
+
+
+      def log_command(text)
+        log text, :cyan
+      end
+
+
+      def log_duration(text)
+        log text, :light_cyan
+      end
+
+
+      def log_header(text)
+        log("\n#{ text }", :light_green)
+      end
+
+
+      def log_error(text)
+        log text, :light_red
+      end
+
+
+      def log_error_and_abort(text)
+        log_error text
+        abort text
+      end
+
+
+      def log_bench(message)
+        log_header message
+        result = nil
+        log_duration "Time elapsed: #{ humanize_time Benchmark.realtime { result = yield } }."
+        result
+      end
+
+
+      # The preferred way to use this method is by passing an array containing the command.
+      # This will ensure that items are properly escaped.
+      # It is also possible to use nested arrays. See tests for example use cases.
+      #
+      # If you want to see how your string command translates into an arry, you can use shellsplit method.
+      #
+      # For example:
+      # 'ruby -v'.shellsplit
+      #  => ["ruby", "-v"]
+      #
+      # If, for some reason, you need to supply a string that is already escaped or should not be escaped, it is
+      # possible to supply a string argument instead of an array. If you do this, you will need to supply
+      # an additional parameter of string_verified_safe, to ensure that the operation is deliberate.
+      def run_command(command, filtered_text: [], quiet: false, string_verified_safe: false)
+        # This method is used *EVERYWHERE*.
+        # Seemingly small changes can have far-ranging and extreme consequences.
+        # Modify only with extreme caution.
+        #
+        # Note: Many applications (like echo and the Flynn CLI) append a newline to their output.
+        #       If you are using the command result, it may be desirable to chomp the trailing
+        #       newline. It is left to the implementing call to handle this, as it proved
+        #       cumbersome to handle in this method in a way that worked perfectly in all cases.
+        raise('Potentially unsafe or problematic command. Please refer to the method documentation for more information.') if command.is_a?(String) && !string_verified_safe
+
+        command = normalized_command(command)
+        logged_command = logged_command(command, filtered_text)
+        log_command(logged_command) unless quiet
+
+        ''.tap do |output|
+          IO.popen(bash(command)) do |io|
+            until io.eof?
+              line = io.gets
+              puts line unless quiet || line.empty?
+              $stdout.flush
+              output.concat line
+            end
+          end
+
+          handle_run_command_error(logged_command, quiet) unless $CHILD_STATUS.success?
+        end
+      end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Find variables changed as a result of sourcing the given file, and update in ENV.
+      def source_env_from(file)
+        bash_source(file).each { |k, v| ENV[k] = v }
+      end
+
+
+      private
+
+
+        def bash(command)
+          ['bash -c', escaped_command(command), '2>&1'].join(' ')
+        end
+
+
+        def logged_command(command, filtered_text)
+          filtered_text = [filtered_text].flatten.delete_if { |text| text.nil? || text.strip.empty? }
+          unescaped_command = command.shellsplit.join(' ')
+          unescaped_command.gsub(Regexp.union(filtered_text.sort_by(&:length).reverse), '[MASKED]')
+        end
+
+
+        def escaped_command(command)
+          command.shellescape
+        end
+
+
+        def normalized_command(command)
+          command.is_a?(Array) ? command.flatten.shelljoin : command
+        end
+
+
+        def handle_run_command_error(logged_command, quiet)
+          error_message = "\nAn error has occurred while running the following command:\n#{ logged_command }\n"
+          quiet ? abort : log_error_and_abort(error_message)
+        end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Read in the bash environment, after an optional command. Returns Array of key/value pairs.
+        def bash_env(cmd = nil)
+          env_cmd = bash("#{ cmd + ';' if cmd } printenv")
+          env = `#{ env_cmd }`
+          env.split(/\n/).map { |l| l.split(/=/, 2) }
+        end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Source a given file, and compare environment before and after. Returns Hash of any keys that have changed.
+        def bash_source(file)
+          Hash[bash_env("source #{ File.realpath file }") - bash_env]
+        end
+
+    end
+  end
+end