neeto-compliance 1.0.58

data/lib/neeto_compliance/verifiers/auto_update_prs_with_latest_master_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class AutoUpdatePrsWithLatestMasterVerifier < Base
+    def local_copy
+      ".github/workflows/auto_update_prs_with_latest_master.yml"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "common_files/github/workflows/auto_update_prs_with_latest_master.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/lib/neeto_compliance/verifiers/base.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "yaml"
+require "set"
+
+module NeetoCompliance
+  class Base
+    def process
+      return true if app_is_exception?
+
+      # preload the path
+      NeetoCompliance::NeetoCommons.path
+
+      success, errors = audit
+
+      unless success
+        errors.each do |error|
+          puts error
+        end
+      else
+        print "[PASS]\n".green
+      end
+
+      success
+    end
+
+    def verifier_name
+      self.class.to_s
+    end
+
+    def print_description
+      print "%-80s" % [verifier_name]
+    end
+
+    def auto_correct!
+      return true if app_is_exception?
+
+      unless valid?
+        puts autofix_command
+        system autofix_command
+      end
+    end
+
+    def autofix_suggestion
+      "To fix run: #{autofix_command.yellow}"
+    end
+
+    def error_message
+      "[FAIL]".red
+    end
+
+    def audit
+      print_description
+      errors = []
+
+      unless valid?
+        errors << [error_message, autofix_suggestion, "\n"].join("\n")
+      end
+
+      [errors.length == 0, errors]
+    end
+
+    def app_is_exception?
+      apps_exception_list.include?(app_name)
+    end
+
+    def app_name
+      @_app_name ||= `git config --get remote.origin.url`.split("/").last.strip.split(".git").first
+    end
+
+    def apps_exception_list
+      []
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/bump_version_with_pr_label_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class BumpVersionWithPrLabelVerifier < Base
+    def local_copy
+      ".github/workflows/bump_version.yml"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "common_files/neeto_gems/github/workflows/bump_version.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/lib/neeto_compliance/verifiers/bundler_version_verifier.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class BundlerVersionVerifier < Base
+    def commons_bundler_version
+      File.read(NeetoCompliance::NeetoCommons.path.join "common_files/.bundler-version").strip
+    end
+
+    def current_bundler_version
+      `tail -n 1 ./Gemfile.lock`.strip
+    end
+
+    def is_same_version_being_used?
+      commons_bundler_version == current_bundler_version
+    end
+
+    def valid?
+      unless is_same_version_being_used?
+        @error = %{
+            Please update the bundler version on your machine to #{commons_bundler_version}
+            You can follow the following steps:
+
+            1. Install the latest bundler version:
+              - gem install bundler
+            2. Open Gemfile.lock of the project:
+              - vim ./Gemfile.lock
+            3. Delete the last line that contains the bundler version.
+            4. Run:
+              - bundle install
+
+            You can also watch the following video that contains the same steps:
+              - https://youtu.be/vqAUIQehbKw
+          }
+        return false
+      end
+
+      true
+    end
+
+    def autofix_suggestion
+      @error.yellow
+    end
+
+    def autofix_command
+      "gem install bundler; perl -p -i -e 's/#{current_bundler_version}(\n*)\\Z/#{commons_bundler_version}\n/m' Gemfile.lock"
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/circleci_config_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class CircleciConfigVerifier < Base
+    def local_copy
+      ".circleci/config.yml"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join local_copy
+    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/lib/neeto_compliance/verifiers/common_gemfile_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class CommonGemfileVerifier < Base
+    def local_copy
+      "Gemfile.common.rb"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "gemfiles", local_copy
+    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/lib/neeto_compliance/verifiers/common_initializers_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class CommonInitializersVerifier < Base
+    def local_copy
+      "config/initializers/common.rb"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "initializers/common.rb"
+    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/lib/neeto_compliance/verifiers/cypress_config_verifier.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class CypressConfigVerifier < Base
+    def cypress_config_files
+      @_cypress_config_files ||= {
+        "cypress-tests/package.json" => NeetoCompliance::NeetoCommons.path.join("cypress/package.json"),
+        "cypress-tests/cypress/jsconfig.json" => NeetoCompliance::NeetoCommons.path.join("cypress/jsconfig.json"),
+        "cypress-tests/cypress/webpack.config.js" => NeetoCompliance::NeetoCommons.path.join("cypress/webpack.config.js"),
+        "cypress-tests/cypress/config/cypress.review.json" => NeetoCompliance::NeetoCommons.path.join("cypress/cypress.review.json"),
+        "cypress-tests/cypress/resolve.js" => NeetoCompliance::NeetoCommons.path.join("cypress/resolve.js")
+      }
+    end
+
+    def auto_correct!
+      unless valid?
+        @autofix_commands.each do |command|
+          puts command
+          system command
+        end
+      end
+    end
+
+    def autofix_suggestion
+      @autofix_commands.join("\n").yellow
+    end
+
+    def valid?
+      @autofix_commands = []
+
+      cypress_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}"
+          @autofix_commands << "cd cypress-tests && yarn" if local_file == "cypress-tests/package.json"
+        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/lib/neeto_compliance/verifiers/cypress_plugins_index_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class CypressPluginsIndexVerifier < Base
+    def local_copy
+      "cypress-tests/cypress/plugins/index.js"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "common_files/cypress-tests/cypress/plugins/index.js"
+    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/lib/neeto_compliance/verifiers/docker_file_dev_verifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class DockerFileDevVerifier < Base
+    def local_copy
+      "Dockerfile.dev"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "common_files/Dockerfile.dev"
+    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/lib/neeto_compliance/verifiers/environment_config_verifier.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class EnvironmentConfigVerifier < Base
+    def environment_configs
+      @_environment_configs ||= {
+        "config/environments/development.rb": "NeetoCommonsBackend::Environments.development(config)",
+        "config/environments/test.rb": "NeetoCommonsBackend::Environments.test(config)",
+        "config/environments/heroku.rb": "NeetoCommonsBackend::Environments.heroku(config)",
+        "config/environments/staging.rb": "NeetoCommonsBackend::Environments.staging(config)",
+        "config/environments/production.rb": "NeetoCommonsBackend::Environments.production(config)",
+        "config/application.rb": "NeetoCommonsBackend::Environments.application(config, self.routes)"
+      }
+    end
+
+    def auto_correct!
+    end
+
+    def valid?
+      @errors = []
+      environment_configs.each_pair do |file, command|
+        unless config_missing?(file, command)
+          @errors << "Add #{command} to #{file}"
+        end
+      end
+
+      @errors.empty?
+    end
+
+    def config_missing?(file, command)
+      system("cat #{file} | grep -q '#{command}'")
+    end
+
+    def autofix_suggestion
+      @errors.join("\n").yellow
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/gem_version_verifier.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class GemVersionVerifier
+    attr_reader :current_version, :latest_version, :gem_name
+
+    def initialize(current_version, latest_version, gem_name)
+      @latest_version = latest_version
+      @current_version = current_version
+      @gem_name = gem_name
+    end
+
+    def gem_not_installed?
+      current_version.nil?
+    end
+
+    def latest_version_installed?
+      current_version == latest_version
+    end
+
+    def equal_app_and_gem_name?
+      app_name == gem_name
+    end
+
+    def valid?
+      equal_app_and_gem_name? || gem_not_installed? || latest_version_installed?
+    end
+
+    def app_name
+      @_app_name ||= `git config --get remote.origin.url`.split("/").last.strip.split(".git").first
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/gems_verifier_base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class GemsVerifierBase < Base
+    def gems
+      []
+    end
+
+    def latest_versions
+      @_latest_versions ||= _latest_versions
+    end
+
+    def _latest_versions
+      JSON.parse(Net::HTTP.get_response(URI("https://neeto-library-stable-versions.herokuapp.com/versions")).body)
+    end
+
+    def valid?
+      @failed_gems = []
+      load_current_versions
+      gems.map do |gem|
+        gv = GemVersionVerifier.new(@current_versions[gem[:name]], find_latest_version(gem[:name]), gem[:name])
+        unless gv.valid?
+          @failed_gems << gem[:name]
+        end
+      end
+
+      @failed_gems.empty?
+    end
+
+    def autofix_command
+      "bundle update #{@failed_gems.join(' ')}"
+    end
+
+    def load_current_versions
+      @current_versions = {}
+      Bundler.load.specs.each { |gem| @current_versions[gem.name] = gem.version.to_s }
+    end
+
+    def find_latest_version(gem_name)
+      gem = latest_versions.find { |gem| gem["name"] == gem_name } || {}
+      gem["released_version"]
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/gitignore_file_verifier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NeetoCompliance
+  class GitignoreFileVerifier < Base
+    def local_copy
+      ".gitignore"
+    end
+
+    def commons_copy
+      NeetoCompliance::NeetoCommons.path.join "common_files", local_copy
+    end
+
+    def verify_command
+      "diff #{commons_copy} #{local_copy}"
+    end
+
+    def valid?
+      @missing_lines = []
+      local_gitignore = process_data File.read(local_copy)
+      common_gitignore = process_data File.read(NeetoCompliance::GitignoreFileVerifier.new.commons_copy)
+      common_gitignore.map { |line| @missing_lines << line unless local_gitignore.include?(line) }
+      @missing_lines.empty?
+    end
+
+    def process_data(gitignore_data)
+      gitignore_data.split("\n").map { |line| line.gsub(/^#.*/, "") }
+    end
+
+    def autofix_command
+      "echo '#{@missing_lines.join("\n")}' >> #{local_copy}"
+    end
+
+    def autofix_suggestion
+      "Add following lines to#{local_copy}: \n#{@missing_lines.join("\n")}".yellow
+    end
+  end
+end

data/lib/neeto_compliance/verifiers/jsconfig_verifier.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "hashdiff"
+
+module NeetoCompliance
+  class JsconfigVerifier < Base
+    attr_accessor :diffs
+
+    def initialize
+      @diffs = []
+    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
+      @_local_jsconfig ||= read_file local_copy
+    end
+
+    def required_jsconfig
+      @_required_jsconfig ||= read_file commons_copy
+    end
+
+    def read_file(file)
+      JSON.parse File.read(file)
+    end
+
+    def verify_command
+      self.diffs = Hashdiff.best_diff(required_jsconfig, local_jsconfig)
+      # diffs is an array of differences and each element is a diff.
+
+      self.diffs.any? { |diff| removed_or_modified?(diff) }
+    end
+
+    def removed_or_modified?(diff)
+      # A diff is of the format: ['-', 'a.x', 2]
+      # A modified key is of the format: ['~', 'a.x', 2, 4]
+      # First element is a symbol. '-' indicates removal and `~` indicates modification
+
+      diff[0] == "-" || diff[0] == "~"
+    end
+
+    def local_file_exists?
+      File.file?(local_copy)
+    end
+
+    def newly_added_paths
+      self.diffs = Hashdiff.diff(required_jsconfig, local_jsconfig, use_lcs: false)
+      capture_addition_into_paths_key = "(?=.*\+)(?=.*compilerOptions.paths)"
+      @_newly_added_paths ||= self.diffs.select { |diff| diff.join =~ /#{capture_addition_into_paths_key}.*/ }
+    end
+
+    def custom_paths
+      paths = Hash.new
+      newly_added_paths.each do |path|
+        if path[0] == "+"
+          key = path[1].split(".").last
+          value = path[2]
+          paths[key] = value
+        end
+      end
+      @_custom_paths ||= paths
+    end
+
+    def modified_paths
+      paths = Hash.new
+      newly_added_paths.each do |path|
+        if path[0] == "~"
+          # An unwanted '[0]' character is added at the to all modified diffs by the gem
+
+          paths[path[1].split(".").last.chomp("[0]")] = { common: path[2], local: path[3] }
+        end
+      end
+      @_modified_paths ||= paths
+    end
+
+    def add_comments_to_jsconfig_file
+      text = File.read(local_copy)
+      text['"commons_paths_comment": "",'] = "// don't modify the below paths without consulting with neetoCompliance team"
+      text['"custom_paths_comment": ""'] = "// You can add custom project specific paths below this comment"
+      File.open(local_copy, "w") { |file| file.puts text }
+    end
+
+    def exception_message(paths)
+      modified_paths = ""
+      paths.each do |key, value|
+        modified_paths += "
+          path: #{key}
+            Common value: [\"#{value[:common]}\"]
+            Project's value: [\"#{value[:local]}\"]"
+      end
+      exception_message = %{
+        Could not autofix jsconfig changes. The below path(s) conflict with the one defined in neeto-commons-backend: #{modified_paths}
+      }
+    end
+
+    def add_place_holders_for_comments
+      # Adds placeholders into the entire object to keep track of places where we need to insert comments
+
+      paths_with_comment =
+        { "commons_paths_comment": "" }.merge(required_jsconfig["compilerOptions"]["paths"])
+      paths_with_comment = paths_with_comment.merge("custom_paths_comment": "")
+      paths_with_comment.merge(custom_paths)
+    end
+
+    def write_jsconfig_object_to_file
+      jsconfig_data = required_jsconfig
+      jsconfig_data["compilerOptions"]["paths"] = add_place_holders_for_comments
+      File.open(local_copy, "w") do |file|
+        file.write(JSON.pretty_generate(jsconfig_data))
+      end
+    end
+
+    def auto_correct!
+      unless valid?
+        if !modified_paths.empty?
+          raise StandardError.new exception_message(modified_paths)
+        end
+
+        write_jsconfig_object_to_file
+        add_comments_to_jsconfig_file
+      end
+    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 neeto_audit_script_command
+      "bundle exec neeto-audit -a"
+    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}
+
+      This can be fixed automatically by running:
+      #{neeto_audit_script_command.yellow}
+
+      To fix manually, 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.
+      if newly_added_paths.empty?
+        return base_message
+      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