neetob 0.1.2 → 0.1.5

data/neeto_compliance/lib/neeto_compliance/verifiers/jsconfig_verifier.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require "hashdiff"
-
-module NeetoCompliance
-  class JsconfigVerifier < Base
-    attr_accessor :diff
-
-    def initialize
-      @diff = []
-    end
-
-    def local_copy
-      "app/javascript/jsconfig.json"
-    end
-
-    def commons_copy
-      NeetoCompliance::NeetoCommons.path.join "common_files", "app", "javascript", "jsconfig.json"
-    end
-
-    def local_jsconfig_data
-      @_local_jsconfig_data ||= JSON.parse(File.read(local_copy))
-    end
-
-    def required_jsconfig_data
-      @_required_jsconfig_data ||= JSON.parse(File.read(commons_copy))
-    end
-
-    def verify_command
-      self.diff = Hashdiff.best_diff(required_jsconfig_data, local_jsconfig_data)
-      removed_symbol = "\-"
-      modified_symbol = "\~"
-      symbol_index = 0
-      self.diff.any? { |p| /#{removed_symbol}|#{modified_symbol}/.match?(p[symbol_index]) }
-    end
-
-    def local_file_exists?
-      File.file?(local_copy)
-    end
-
-    def valid?
-      return false unless local_file_exists?
-
-      is_modified_or_removed = verify_command
-      !is_modified_or_removed
-    end
-
-    def autofix_command
-      "cp #{commons_copy} #{local_copy}"
-    end
-
-    def upstream_copy
-      "https://github.com/bigbinary/neeto-commons-backend/blob/stable/lib/neeto-commons-backend/common_files/app/javascript/jsconfig.json"
-    end
-
-    def autofix_suggestion
-      base_message = %{
-      Your jsconfig.json content doesn't match with the expected neeto-commons content.
-
-      The following is the recommended jsconfig.json content in neeto ecosystem:
-      1) View #{upstream_copy}
-      2) Or open #{commons_copy}
-
-      To fix, start by fully replacing app/javascript/jsconfig.json
-      of your app with above mentioned content, by running the following:
-      #{autofix_command.yellow}
-      }
-
-      # The following is an example diff:
-      # [["-", "compilerOptions.moduleResolution", "NodeNext"],
-      # ["~", "compilerOptions.module", "ESNext", "ESNex"],
-      # ["+", "compilerOptions.paths.neetou", ["../../node_modules/@bigbinary/neetoui/**"]],
-      # For the above diff, we only need to get the newly added items marked by "+"
-      # and also check whether it's a "path" that has been added.
-      capture_addition_into_paths_key = "(?=.*\+)(?=.*compilerOptions.paths)"
-      new_paths = self.diff.select { |p| p.join =~ /#{capture_addition_into_paths_key}.*/ }
-      if new_paths.empty?
-        return base_message
-      end
-
-      custom_paths = Hash.new
-      new_paths.each do |path|
-        k = path[1].split(".").last
-        v = path[2]
-        custom_paths[k] = v
-      end
-
-      message = %{
-      #{base_message}
-      ==================================================
-      It seems that you've also added some custom paths in your jsconfig. You can cherry pick and
-      append the custom paths to app/javascript/jsconfig.json, if need be, after running above mentioned copy command.
-      Refer the comments in #{upstream_copy}
-      to see how to add custom paths.
-      The following are the custom paths that we have detected in your app/javascript/jsconfig.json:
-      #{JSON.pretty_generate(custom_paths).yellow}
-      }
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/neeto_auth_gems_verifier.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class NeetoAuthGemsVerifier < GemsVerifierBase
-    def gems
-      [
-        { name: "neeto-commons-backend", repo: "bigbinary/neeto-commons-backend" },
-        { name: "neeto-compliance", repo: "bigbinary/neeto-compliance" },
-        { name: "neeto-area51-engine", repo: "bigbinary/neeto-area51-engine" },
-        { name: "neeto-team-members-engine", repo: "bigbinary/neeto-team-members-engine" },
-        { name: "neeto-org-incineration-engine", repo: "bigbinary/neeto-org-incineration-engine" },
-        # { name: "neeto-emails", repo: "bigbinary/neeto-emails" },
-        { name: "neeto-email-prefixer", repo: "bigbinary/neeto-email-prefixer" },
-        { name: "neeto-mail-interceptor", repo: "bigbinary/neeto-mail-interceptor" },
-        { name: "neeto-filters-engine", repo: "bigbinary/neeto-filters-engine" },
-        { name: "neeto-custom-domains-engine", repo: "bigbinary/neeto-custom-domains-engine" },
-      ]
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/neeto_commons_sync_verifier.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class NeetoCommonsSyncVerifier < Base
-    def webpack_config_files
-      @_webpack_config_files ||= {
-        "config/webpack/development.js" => NeetoCompliance::NeetoCommons.path.join("webpack/development.js"),
-        "config/webpack/production.js" => NeetoCompliance::NeetoCommons.path.join("webpack/production.js"),
-        "config/webpack/staging.js" => NeetoCompliance::NeetoCommons.path.join("webpack/staging.js"),
-        "config/webpack/test.js" => NeetoCompliance::NeetoCommons.path.join("webpack/test.js")
-      }
-    end
-
-    def auto_correct!
-      @autofix_commands.each do |command|
-        puts command
-        system(command)
-      end
-    end
-
-    def autofix_suggestion
-      @autofix_commands.join("\n").yellow
-    end
-
-    def valid?
-      @autofix_commands = []
-
-      webpack_config_files.each_pair do |local_file, common_file|
-        unless same_file?(local_file, common_file)
-          @autofix_commands << "cp #{common_file.to_s} #{local_file}"
-        end
-      end
-
-      @autofix_commands.length == 0
-    end
-
-    def same_file?(local_file, common_file)
-      File.exist?(local_file) &&
-      `diff #{local_file} #{common_file.to_s}`.empty?
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/neeto_gems_version_verifier.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class NeetoGemsVerifier < GemsVerifierBase
-    def gems
-      [
-        { name: "neeto-commons-backend", repo: "bigbinary/neeto-commons-backend" },
-        { name: "neeto-compliance", repo: "bigbinary/neeto-compliance" },
-        { name: "neeto-area51-engine", repo: "bigbinary/neeto-area51-engine" },
-        { name: "neeto-sso", repo: "bigbinary/neeto-sso" },
-        { name: "neeto-team-members-engine", repo: "bigbinary/neeto-team-members-engine" },
-        { name: "neeto-org-incineration-engine", repo: "bigbinary/neeto-org-incineration-engine" },
-        # { name: "neeto-emails", repo: "bigbinary/neeto-emails" },
-        { name: "neeto-email-prefixer", repo: "bigbinary/neeto-email-prefixer" },
-        { name: "neeto-mail-interceptor", repo: "bigbinary/neeto-mail-interceptor" },
-        { name: "neeto-payments-engine", repo: "bigbinary/neeto-payments-engine" },
-        { name: "neeto-notifications-engine", repo: "bigbinary/neeto-notifications-engine" },
-        { name: "neeto-tags-engine", repo: "bigbinary/neeto-tags-engine" },
-        { name: "neeto-filters-engine", repo: "bigbinary/neeto-filters-engine" },
-        { name: "neeto-custom-domains-engine", repo: "bigbinary/neeto-custom-domains-engine" },
-      ]
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/newrelic_verifier.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class NewrelicVerifier < Base
-    def local_copy
-      "config/newrelic.yml"
-    end
-
-    def commons_copy
-      NeetoCompliance::NeetoCommons.path.join "common_files/newrelic.yml"
-    end
-
-    def verify_command
-      "diff -N #{commons_copy} #{local_copy}"
-    end
-
-    def valid?
-      `#{verify_command}`.empty?
-    end
-
-    def autofix_command
-      "cp #{commons_copy} #{local_copy}"
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/node_version_verifier.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class NodeVersionVerifier < Base
-    def node_version
-      JSON.parse(open(common_packages_latest_file).read)["engines"]["node"]
-    end
-
-    def package_json_engines
-      JSON.parse(open("package.json").read)["engines"]
-    end
-
-    def auto_correct!
-    end
-
-    def autofix_suggestion
-      @errors.join("\n").yellow
-    end
-
-    def valid?
-      @errors = []
-      unless updated_nvmrc_file?
-        @errors << "Update node version in .nvmrc to #{node_version}"
-      end
-
-      unless updated_node_version_file?
-        @errors << "Update node version in .node-version to #{node_version}"
-      end
-
-      unless check_node_step_added_to_semahore_config?
-        @errors << "Add node version to your semaphore.yml as shown below:
-            global_job_config:
-              prologue:
-                commands:
-                  - checkout
-                  - sem-version ruby 3.0.1
-                  - sem-version node #{node_version}
-                  - sem-service start postgres 12.4
-           \n "
-      end
-
-      @errors.length == 0
-    end
-
-    def updated_node_version_file?
-      node_version == File.open(".node-version").read.chomp
-    end
-
-    def updated_nvmrc_file?
-      node_version == File.open(".nvmrc").read.chomp
-    end
-
-    def check_node_step_added_to_semahore_config?
-      semaphore_config = YAML.load(File.open(".semaphore/semaphore.yml").read, aliases: true)
-      semaphore_command = "sem-version node #{node_version}"
-      semaphore_config["global_job_config"]["prologue"]["commands"].include?(semaphore_command)
-    end
-
-    def common_packages_latest_file
-      NeetoCompliance::NeetoCommons.path.join "common_files/package-common.json"
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/package_dependencies_version_verifier.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module NeetoCompliance
-  class PackageDependenciesVersionVerifier < Base
-    def valid?
-      @common_package_json = load_json_file(common_packages_latest_file)
-      @project_package_json = load_json_file("package.json")
-
-      @incorrect_dependencies = {
-        dependencies: find_incorrect_dependencies(:dependencies),
-        devDependencies: find_incorrect_dependencies(:devDependencies)
-      }
-      @incorrect_dependencies[:misplacedDependencies] = find_misplaced_dependencies
-      @incorrect_dependencies.keys.all? { |key| @incorrect_dependencies[key].empty? }
-    end
-
-    def auto_correct!
-    end
-
-    def autofix_command
-      command = ""
-      command += "yarn remove #{@incorrect_dependencies[:misplacedDependencies]
-        .join(" ")}\n" unless @incorrect_dependencies[:misplacedDependencies].empty?
-      command += "yarn add #{@incorrect_dependencies[:dependencies]
-        .join(" ")}\n" unless @incorrect_dependencies[:dependencies].empty?
-      command += "yarn add -D #{@incorrect_dependencies[:devDependencies]
-        .join(" ")}\n" unless @incorrect_dependencies[:devDependencies].empty?
-      command
-    end
-
-    private
-
-      def common_packages_latest_file
-        NeetoCompliance::NeetoCommons.path.join "common_files/package-common.json"
-      end
-
-      def find_misplaced_dependencies
-        project_dependencies = @project_package_json[:dependencies]
-        @common_package_json[:devDependencies].inject([]) do |result, (package_name, latest_version)|
-          next result unless project_dependencies.key?(package_name)
-
-          @incorrect_dependencies[:devDependencies] |= ["\"#{package_name}@#{latest_version}\""]
-          result.push("#{package_name}")
-        end
-      end
-
-      def find_incorrect_dependencies(key)
-        project_dependencies = @project_package_json[key]
-        @common_package_json[key].inject([]) do |result, (package_name, latest_version)|
-          next result if project_dependencies[package_name] == latest_version
-
-          result.push("\"#{package_name}@#{latest_version}\"")
-        end
-      end
-
-      def load_json_file(url)
-        JSON.parse(open(url).read, symbolize_names: true)
-      end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/package_json_verifier.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-KEYS_TO_CHECK = %w[engines lint-staged].freeze
-
-module NeetoCompliance
-  class PackageJsonVerifier < Base
-    def valid?
-      @common_lint_staged = JSON.parse(open(common_packages_latest_file).read)
-      project_lint_staged = JSON.parse(open("package.json").read)
-
-      @results = KEYS_TO_CHECK.map { |key| @common_lint_staged[key].to_json === project_lint_staged[key].to_json }
-      @results.all?
-    end
-
-    def auto_correct!
-    end
-
-    def autofix_command
-      return "" if @results.all?
-
-      command = ""
-      KEYS_TO_CHECK.each_with_index do |key, index|
-        next if @results[index]
-
-        command += "Replace the value of \"#{key}\" in package.json with:\n\n#{JSON.pretty_generate(@common_lint_staged[key])}\n\n"
-      end
-
-      command
-    end
-
-    private
-
-      def common_packages_latest_file
-        NeetoCompliance::NeetoCommons.path.join "common_files/package-common.json"
-      end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/roles_verifier.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  # To verify if the `roles.yml` file exist in the host application.
-  class RolesVerifier < Base
-    def local_copy
-      "config/roles.yml"
-    end
-
-    def commons_copy
-      NeetoCompliance::NeetoCommons.path.join "common_files/roles.yml"
-    end
-
-    def valid?
-      File.exist?(local_copy)
-    end
-
-    def autofix_command
-      "cp #{commons_copy} #{local_copy}"
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/ruby_version_verifier.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class RubyVersionVerifier < Base
-    def local_copy
-      ".ruby-version"
-    end
-
-    def commons_copy
-      NeetoCompliance::NeetoCommons.path.join "common_files/.ruby-version"
-    end
-
-    def verify_command
-      "diff -N #{commons_copy} #{local_copy}"
-    end
-
-    def valid?
-      `#{verify_command}`.empty?
-    end
-
-    def autofix_command
-      "cp #{commons_copy} #{local_copy}"
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/semaphoreci_config_verifier.rb

@@ -1,162 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class SemaphoreciConfigVerifier < Base
-    def local_copy
-      ".semaphore/semaphore.yml"
-    end
-
-    def auto_correct!
-    end
-
-    def semaphore_config
-      @_semaphore_config ||= YAML.load(File.open(local_copy).read, aliases: true)
-    end
-
-    def my_container_setup_commands
-      semaphore_config["global_job_config"]["prologue"]["commands"]
-    end
-
-    def my_jobs_config
-      semaphore_config["blocks"].map { |block| block["task"]["jobs"] }
-    end
-
-    def my_env_vars_config
-      semaphore_config["global_job_config"]["env_vars"]
-    end
-
-    def my_after_pipeline_jobs
-      semaphore_config["after_pipeline"]["task"]
-    end
-
-    def my_machine_type
-      semaphore_config["agent"]["machine"]["type"]
-    end
-
-    def machine_type
-      "e1-standard-2"
-    end
-
-    def container_setup_commands
-      [
-        "checkout",
-        "sem-version ruby 3.1.2",
-        "sem-version node 18.12",
-        "sem-service start postgres 13",
-        "sem-service start redis",
-        "bundle config path 'vendor/bundle'",
-        "cp config/database.yml.ci config/database.yml",
-        "bundle install --jobs 1",
-      ]
-    end
-
-    def jobs_config
-      [
-        [
-          {
-            "name" => "Checks",
-            "commands" =>
-              [
-                "bundle exec ruby-audit check",
-                "bundle exec rubocop",
-                "bundle exec erblint --lint-all --format compact",
-                "curl -s -L \"https://raw.githubusercontent.com/bigbinary/wheel/main/.semaphore/commands/run_eslint_on_modified_files.sh\" | bash",
-                "bundle exec neeto-audit",
-                "bundle exec rake db:create db:schema:load --trace",
-                "bundle exec rake incinerator:check_for_missing_models",
-                "bundle exec rails test",
-                "bundle exec rake simplecov_coverage:publish",
-                "test-results publish ./test/reports",
-                "bundle exec rake setup"
-              ]
-          }
-        ]
-      ]
-    end
-
-    def env_vars_config
-      [
-        {
-          "name" => "TZ",
-          "value" => "UTC"
-        },
-        {
-          "name" => "RAILS_ENV",
-          "value" => "test"
-        },
-        {
-          "name" => "RACK_ENV",
-          "value" => "test"
-        }
-      ]
-    end
-
-    def after_pipeline_jobs
-      {
-        "jobs" => [
-          {
-            "name" => "Publish Results",
-            "commands" => ["test-results gen-pipeline-report"]
-          }
-        ]
-      }
-    end
-
-    def standard_semaphore_config_file
-      NeetoCompliance::NeetoCommons.path.join "common_files/semaphore/semaphore.yml"
-    end
-
-    def semaphore_config_valid?
-      @semaphore_errors = []
-      @no_errors = true
-
-      begin
-        container_setup_commands.each do |cmd|
-          unless my_container_setup_commands.include?(cmd)
-            @semaphore_errors << "Missing: \"#{cmd}\" in global_job_config"
-            @no_errors = false
-          end
-        end
-
-        unless jobs_config == my_jobs_config
-          @semaphore_errors << "Blocks configuration should be same as in #{standard_semaphore_config_file}"
-          @no_errors = false
-        end
-
-        unless env_vars_config == my_env_vars_config
-          @semaphore_errors << "Env vars configuration should be same as in #{standard_semaphore_config_file}"
-          @no_errors = false
-        end
-
-        unless after_pipeline_jobs == my_after_pipeline_jobs
-          @semaphore_errors << "after_pipeline jobs configuration should be same as in #{standard_semaphore_config_file}"
-          @no_errors = false
-        end
-
-        unless machine_type == my_machine_type
-          @semaphore_errors << "Machine type should be #{machine_type}"
-          @no_errors = false
-        end
-
-      rescue => e
-        p e
-        return false
-      end
-
-      @no_errors
-    end
-
-    def autofix_suggestion
-      @error.yellow
-    end
-
-    def valid?
-      unless semaphore_config_valid?
-        @error = %{SemaphoreCI configuration (.semaphore/semaphore.yml) is incomplete/incorrect. \n#{@semaphore_errors.join("\n")} \n}
-        return false
-      end
-
-      true
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/sidekiq_queues_verifier.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class SidekiqQueuesVerifier < Base
-    def local_copy
-      "config/sidekiq.yml"
-    end
-
-    def queues
-      @_queues ||= ["active_storage_analysis", "active_storage_purge"]
-    end
-
-    def valid?
-      @errors = []
-
-      sidekiq_yml = YAML.load(File.open(local_copy), aliases: true)
-
-      queues.map do |queue|
-        unless sidekiq_yml["queues"].include?(queue)
-          @errors << "Add #{queue} to queues in #{local_copy}"
-        end
-      end
-
-      @errors.length == 0
-    end
-
-    def autofix_suggestion
-      @errors.join("\n").yellow
-    end
-
-    def auto_correct!
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/simplecov_config_verifier.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class SimplecovConfigVerifier < Base
-    def test_helper
-      "test/test_helper.rb"
-    end
-
-    def valid?
-      @errors = []
-
-      check_file = Set.new(File.readlines(test_helper).collect(&:chomp))
-
-      if check_file.include?("NeetoCommonsBackend.simplecov_config")
-        @errors << "Remove NeetoCommons.simplecov_config from #{test_helper}"
-      end
-
-      @errors.length == 0
-    end
-
-    def autofix_suggestion
-      @errors.join("\n").yellow
-    end
-
-    def auto_correct!
-    end
-  end
-end

data/neeto_compliance/lib/neeto_compliance/verifiers/sitemap_config_verifier.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module NeetoCompliance
-  class SitemapConfigVerifier < Base
-    def local_copy
-      "public/sitemap.xml"
-    end
-
-    def commons_copy
-      NeetoCompliance::NeetoCommons.path.join "common_files", "sitemap.xml"
-    end
-
-    def verify_command
-      "diff -N #{commons_copy} #{local_copy}"
-    end
-
-    def valid?
-      `#{verify_command}`.empty?
-    end
-
-    def autofix_command
-      "cp #{commons_copy} #{local_copy}"
-    end
-
-    def apps_exception_list
-      ["neeto-kb-web.git"]
-    end
-  end
-end