satorix 0.0.1 → 1.5.3

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

@@ -0,0 +1,220 @@
+module Satorix
+  module CI
+    module Shared
+
+
+      # This code was inspired by:
+      # herokuish - https://github.com/gliderlabs/herokuish
+      # flynn - https://github.com/flynn/flynn/blob/master/slugbuilder/builder/build.sh
+      module BuildpackManager
+
+
+        require 'fileutils'
+
+
+        include Satorix::Shared::Console
+
+
+        extend self
+
+
+        def go
+          abort_if_skip_buildpack
+          prepare_buildpack_environment
+          run_buildpacks
+          load_dot_release_file
+          switch_context_to_new_test_slug
+        end
+
+
+        def active_buildpack_list
+          custom_buildpack_list || stack_buildpack_list
+        end
+
+
+        def active_buildpacks
+          active_buildpack_list.split.map { |buildpack| Buildpack.new buildpack }
+        end
+
+
+        def cedar_14?
+          stack_version == 'cedar-14'
+        end
+
+
+        def copy_app_dir
+          FileUtils.cp_r File.join(Satorix.build_dir, '/.'), Satorix.app_dir, remove_destination: true
+        end
+
+
+        def custom_buildpack_list
+          IO.binread(files[:dot_buildpacks]).strip if custom_buildpacks?
+        end
+
+
+        def custom_buildpacks?
+          File.exist? files[:dot_buildpacks]
+        end
+
+
+        def default_buildpack_list
+          # When updating, pull from the most recent nightly release listed at https://releases.flynn.io/.
+          # Below was taken from https://github.com/flynn/flynn/blob/v20190814.0/slugbuilder/builder/buildpacks.txt
+          <<-THESE_ARE_THE_BUILDPACKS_OFFICIALLY_SUPPORTED_BY_FLYNN.strip
+              https://github.com/heroku/heroku-buildpack-multi.git#ed950773
+              https://github.com/cloudfoundry/staticfile-buildpack.git#e482e8f2
+              https://github.com/heroku/heroku-buildpack-ruby.git#4ca71a9d
+              https://github.com/heroku/heroku-buildpack-nodejs.git#a4fb9419
+              https://github.com/heroku/heroku-buildpack-clojure.git#5858bad3
+              https://github.com/heroku/heroku-buildpack-python.git#9dcabe24
+              https://github.com/heroku/heroku-buildpack-java.git#354d2a79
+              https://github.com/heroku/heroku-buildpack-gradle.git#b89c8c38
+              https://github.com/heroku/heroku-buildpack-scala.git#41c296d4
+              https://github.com/heroku/heroku-buildpack-php.git#62a691bf
+              https://github.com/heroku/heroku-buildpack-go.git#6f80fd9c
+          THESE_ARE_THE_BUILDPACKS_OFFICIALLY_SUPPORTED_BY_FLYNN
+        end
+
+
+        def default_cedar_14_buildpack_list
+          # When updating, pull from the most recent stable release listed at https://releases.flynn.io/.
+          # Below was taken from https://github.com/flynn/flynn/blob/v20170321.0/slugbuilder/builder/buildpacks.txt
+          <<-THESE_ARE_THE_BUILDPACKS_OFFICIALLY_SUPPORTED_BY_FLYNN.strip
+              https://github.com/heroku/heroku-buildpack-multi.git#ed950773
+              https://github.com/cloudfoundry/staticfile-buildpack.git#206728f9
+              https://github.com/heroku/heroku-buildpack-ruby.git#6988832f
+              https://github.com/heroku/heroku-buildpack-nodejs.git#9b8a98d8
+              https://github.com/heroku/heroku-buildpack-clojure.git#8768a8ff
+              https://github.com/heroku/heroku-buildpack-python.git#cafd4182
+              https://github.com/heroku/heroku-buildpack-java.git#8c34efe9
+              https://github.com/heroku/heroku-buildpack-gradle.git#13fa1fe7
+              https://github.com/heroku/heroku-buildpack-scala.git#dd0dd806
+              https://github.com/heroku/heroku-buildpack-play.git#cc5e6166
+              https://github.com/heroku/heroku-buildpack-php.git#e0499a7f
+              https://github.com/heroku/heroku-buildpack-go.git#bd1acfe5
+          THESE_ARE_THE_BUILDPACKS_OFFICIALLY_SUPPORTED_BY_FLYNN
+        end
+
+
+        def files
+          build_dir = Satorix.build_dir
+          { dot_buildpacks: File.join(build_dir, '.buildpacks'),
+            dot_env: File.join(build_dir, '.env'),
+            dot_release: File.join(build_dir, '.release') }
+        end
+
+
+        def load_dot_release_file
+          # TODO : Currently not required. Maybe should be implemented for maximum compatibility?
+          log_error_and_abort "Unhandled file '#{ files[:dot_release] }'." if File.exists? files[:dot_release]
+        end
+
+
+        def prepare_buildpack_environment
+          log_bench 'Preparing buildpack environment...' do
+            set_buildpack_expectations
+            process_dot_env_file
+          end
+        end
+
+
+        def process_dot_env_file
+          # TODO : Currently not required. Maybe should be implemented for maximum compatibility?
+          log_error_and_abort "Unhandled file '#{ files[:dot_env] }'" if File.exists? files[:dot_env]
+        end
+
+
+        def load_env
+          # TODO : Currently not required. Maybe should be implemented for maximum compatibility?
+          log_error_and_abort 'Unhandled load_env' unless (Dir.entries(Satorix.paths[:env]) - %w(. ..)).empty?
+        end
+
+
+        def load_profile
+          profile_locations.each do |profile_location|
+            Dir.glob(profile_location) do |shell_file|
+              # Uncomment below to debug profile loading
+              # run_command "cat #{ shell_file }"
+              source_env_from shell_file
+            end
+          end
+        end
+
+
+        def profile_locations
+          [File.join('/etc/profile.d', '*.sh'),
+           File.join(Satorix.app_dir, '.profile.d', '*.sh')]
+        end
+
+
+        def run_buildpacks
+          buildpacks = []
+
+          log_bench('Detecting application type...') do
+            active_buildpacks.each(&:ensure_correctness)
+            buildpacks = active_buildpacks.keep_if(&:detected?)
+
+            if buildpacks.empty?
+              log_error_and_abort 'Unable to select a buildpack!'
+            elsif buildpacks.length > 1 && !custom_buildpacks?
+              log_error("\n\nWarning: Multiple default buildpacks reported the ability to handle this app."\
+                              " The first buildpack in the list above will be used.\n\n")
+              buildpacks = buildpacks.first(1)
+            end
+          end
+
+          buildpacks.each(&:compile)
+        end
+
+
+        def set_buildpack_expectations
+          ENV['APP_DIR'] = Satorix.app_dir
+          ENV['REQUEST_ID'] = "commit-#{ Satorix.ci_commit_sha }"
+          ENV['STACK'] = stack_version
+          ENV['DATABASE_URL'] = Satorix::CI::Test::Shared::Database.url
+
+          ENV['CURL_CONNECT_TIMEOUT'] = '30'
+          ENV['CURL_TIMEOUT'] = '600'
+        end
+
+
+        def abort_if_skip_buildpack
+          if ENV['SKIP_BUILDPACK']
+            log_error_and_abort("\n\nDEPRECATED: Skipping buildpack is no longer supported, please update your .gitlab-ci.yml.\n\n")
+          end
+        end
+
+
+        def stack_version
+          if File.exists?('/etc/lsb-release')
+            File.open('/etc/lsb-release', 'r').read.each_line do |line|
+              if line =~ /DISTRIB_RELEASE=14.04/
+                return 'cedar-14'
+              elsif line =~ /DISTRIB_RELEASE=18.04/
+                return 'heroku-18'
+              end
+            end
+          end
+          # Fallback to heroku-18 if we can't determine a stack
+          return 'heroku-18'
+        end
+
+
+        def stack_buildpack_list
+          cedar_14? ? default_cedar_14_buildpack_list : default_buildpack_list
+        end
+
+
+        def switch_context_to_new_test_slug
+          log_bench 'Switching context to the newly built application...' do
+            copy_app_dir
+            load_env
+            load_profile
+          end
+        end
+
+
+      end
+    end
+  end
+end

data/lib/satorix/CI/shared/ruby/gem_manager.rb

@@ -0,0 +1,80 @@
+module Satorix
+  module CI
+    module Shared
+      module Ruby
+        module GemManager
+
+          include Satorix::Shared::Console
+
+          extend self
+
+
+          def go(quiet = true)
+            if Satorix.ci_job_stage == 'deploy'
+              prepare_gem_for_deployment(quiet)
+            else
+              prepare_gem_environment_for_test(quiet)
+            end
+          end
+
+
+          def prepare_gem_for_deployment(quiet = true)
+            log_bench 'Preparing gem for deployment...' do
+              # Development dependencies should not be included in the Gemfile.lock
+              # otherwise they will become dependencies of the implementing application
+              remove_development_dependencies_from_gemspec(quiet)
+              regenerate_gemfile_lock(quiet)
+            end
+          end
+
+
+          def prepare_gem_environment_for_test(quiet = true)
+            log_bench 'Preparing gem environment...' do
+              restore_missing_gems(quiet)
+            end
+          end
+
+
+          def restore_missing_gems(quiet = true)
+            # The buildpack incorrectly removes gems that are included using add_development_dependency.
+            # These gems must remain available for testing.
+            run_command('bundle install --with development', quiet: quiet)
+          end
+
+
+          def remove_development_dependencies_from_gemspec(quiet = true)
+            Dir[File.join(Satorix.app_dir, '*.gemspec')].each do |file|
+              log File.read(file) unless quiet
+
+              backup_file_name = "#{ file }.satorix.old"
+              FileUtils.mv(file, backup_file_name)
+
+              File.open(file, 'w') do |modified_file|
+                File.foreach(backup_file_name) do |line|
+                  modified_file.puts line unless line =~ /\.add_development_dependency/
+                end
+              end
+
+              File.delete(backup_file_name)
+
+              log File.read(file) unless quiet
+            end
+
+          end
+
+
+          def regenerate_gemfile_lock(quiet = true)
+            run_command('bundle config --local frozen false', quiet: quiet)
+            run_command('bundle install', quiet: quiet)
+            log "\n\n#{ File.read(File.join(Satorix.app_dir, 'Gemfile.lock')) }" unless quiet
+          end
+
+
+        end
+      end
+    end
+  end
+end
+
+
+

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

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

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

@@ -0,0 +1,38 @@
+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 '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,30 @@
+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 'python --version' }
+            log_bench('Installing Safety...') {run_command 'pip install safety'}
+            log_bench('Auditing requirements.txt...') { run_scan }
+          end
+
+
+          def run_scan
+            run_command "safety check -r requirements.txt"
+          end
+
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+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 '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,35 @@
+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 '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 'bundle-audit check --update'
+          end
+
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+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 'ruby -v' }
+            log_bench('Running Cucumber...') { run_cucumber }
+          end
+
+
+          def run_cucumber
+            run_command 'bundle exec cucumber'
+          end
+
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+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 'ruby -v' }
+            log_bench('Running Rails test...') { run_scan }
+          end
+
+
+          def run_scan
+            run_command 'rails test'
+          end
+
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+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 'ruby -v' }
+            log_bench('Running specs...') { run_specs }
+          end
+
+
+          def run_specs
+            run_command '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 '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
+            run_command "rubocop --require rubocop-performance #{ '--require rubocop-rails ' if Satorix.rails_app? }--display-cop-names --extra-details --display-style-guide --parallel"
+          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 '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