repo_analyzer 1.0.0

data/spec/extractors/brakeman_extractor_spec.rb

@@ -0,0 +1,73 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::BrakemanExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:file) do
+      instance_double(
+        "Brakeman::FilePath",
+        relative: "app/controllers/api/base_controller.rb"
+      )
+    end
+
+    let(:warning) do
+      instance_double(
+        "Brakeman::Warning",
+        warning_type: "Basic Auth",
+        check: "Brakeman::CheckBasicAuth",
+        message: "Basic authentication password stored in source code",
+        file: file,
+        link: "https://bla.com",
+        line: 14,
+        confidence: 0,
+        format_code: "where(bla: 1)"
+      )
+    end
+
+    let(:warnings) do
+      [
+        warning
+      ]
+    end
+
+    let(:checks) do
+      instance_double(
+        "Brakeman::Checks",
+        warnings: warnings
+      )
+    end
+
+    let(:tracker) do
+      instance_double(
+        "Brakeman::Tracker",
+        checks: checks
+      )
+    end
+
+    let(:expected) do
+      {
+        "warning_type" => "Basic Auth",
+        "check" => "Brakeman::CheckBasicAuth",
+        "message" => "Basic authentication password stored in source code",
+        "file_path" => "app/controllers/api/base_controller.rb",
+        "link" => "https://bla.com",
+        "line" => 14,
+        "confidence" => "High",
+        "code" => "where(bla: 1)"
+      }
+    end
+
+    before do
+      allow(Brakeman).to receive(:run).and_return(tracker)
+    end
+
+    it { expect(extract[:brakeman_extractor]["warnings"].first).to eq(expected) }
+
+    context "without warnings" do
+      let(:warnings) do
+        []
+      end
+
+      it { expect(extract[:brakeman_extractor]["warnings"].count).to eq(0) }
+    end
+  end
+end

data/spec/extractors/circleci_extractor_spec.rb

@@ -0,0 +1,45 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::CircleciExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:expected) do
+      {
+        "code_coverage" => true,
+        "jest" => true,
+        "rspec" => true,
+        "system_tests" => true,
+        "eslint" => true,
+        "rubocop" => true,
+        "stylelint" => true,
+        "platanus_compose" => false
+      }
+    end
+
+    before do
+      mock_file_content(".circleci/config.yml", "valid_circleci_config.yml")
+    end
+
+    it { expect(extract).to eq(circleci_extractor: expected) }
+
+    context "with old config" do
+      let(:expected) do
+        {
+          "code_coverage" => false,
+          "jest" => true,
+          "rspec" => true,
+          "system_tests" => false,
+          "eslint" => false,
+          "rubocop" => false,
+          "stylelint" => false,
+          "platanus_compose" => true
+        }
+      end
+
+      before do
+        mock_file_content(".circleci/config.yml", "old_circleci_config.yml")
+      end
+
+      it { expect(extract).to eq(circleci_extractor: expected) }
+    end
+  end
+end

data/spec/extractors/github_extractor_spec.rb

@@ -0,0 +1,77 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::GithubExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:commits) do
+      [
+        {
+          commit: {
+            author: {
+              date: "1984-04-06"
+            }
+          },
+          author: {
+            login: "lean"
+          }
+        },
+        {
+          commit: {
+            author: {
+              date: "1983-03-02"
+            }
+          },
+          author: {
+            login: "lean"
+          }
+        },
+        {
+          commit: {
+            author: {
+              date: "1982-03-01"
+            }
+          },
+          author: {
+            login: "santi"
+          }
+        }
+      ]
+    end
+
+    let(:contributors) do
+      [
+        {
+          login: "lean",
+          avatar_url: "http://lean@github.com",
+          contributions: 200
+        },
+        {
+          login: "matias",
+          avatar_url: "http://mati@github.com",
+          contributions: 100
+        },
+        {
+          login: "santi",
+          avatar_url: "http://santi@github.com",
+          contributions: 700
+        }
+      ]
+    end
+
+    before do
+      allow(project_data_bridge).to receive(:commits).and_return(commits)
+      allow(project_data_bridge).to receive(:contributors).and_return(contributors)
+    end
+
+    def last_contributors_logins
+      extract[:github_extractor][:last_contributors].map { |contributor| contributor[:login] }
+    end
+
+    def contributors_logins
+      extract[:github_extractor][:contributors].map { |contributor| contributor[:login] }
+    end
+
+    it { expect(extract[:github_extractor][:last_commit_date]).to eq("1984-04-06") }
+    it { expect(contributors_logins).to contain_exactly("lean", "matias", "santi") }
+    it { expect(last_contributors_logins).to contain_exactly("lean", "santi") }
+  end
+end

data/spec/extractors/power_types_extractor_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::PowerTypesExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:expected) do
+      {
+        "clients" => false,
+        "commands" => true,
+        "observers" => true,
+        "services" => false,
+        "utils" => false,
+        "values" => false
+      }
+    end
+
+    it { expect(extract).to eq(power_types_extractor: expected) }
+  end
+end

data/spec/extractors/project_config_extractor_spec.rb

@@ -0,0 +1,52 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::ProjectConfigExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:expected) do
+      {
+        "simplecov" => false,
+        "makefile_commands" => [],
+        "rubocop_rules" => []
+      }
+    end
+
+    it { expect(extract).to eq(project_config_extractor: expected) }
+
+    context "with existent config files" do
+      let(:expected) do
+        {
+          "simplecov" => true,
+          "makefile_commands" => [
+            "backup-production",
+            "backup-staging",
+            "restore-from-production",
+            "restore-from-staging",
+            "services-port"
+          ],
+          "rubocop_rules" => [
+            "AllCops",
+            "Layout/ParameterAlignment",
+            "Lint/StructNewOverride",
+            "Metrics/BlockLength",
+            "Performance",
+            "Performance/RedundantBlockCall",
+            "RSpec/MultipleExpectations",
+            "Rails",
+            "Rails/Delegate",
+            "Style/ClassAndModuleChildren",
+            "Style/FormatString",
+            "Style/FrozenStringLiteralComment"
+          ]
+        }
+      end
+
+      before do
+        mock_file_content("Makefile", "valid_makefile")
+        mock_file_content(".rubocop.yml", "valid_rubocop_rules.yml")
+        mock_file_existance("spec/simplecov_config.rb")
+      end
+
+      it { expect(extract).to eq(project_config_extractor: expected) }
+    end
+  end
+end

data/spec/extractors/project_versions_extractor_spec.rb

@@ -0,0 +1,63 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::ProjectVersionsExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:expected) do
+      {
+        "circleci_version" => nil,
+        "eslint_version" => nil,
+        "node_version" => nil,
+        "paperclip_version" => nil,
+        "rails_version" => nil,
+        "rubocop_version" => nil,
+        "shrine_version" => nil,
+        "sidekiq_version" => nil,
+        "stylelint_version" => nil,
+        "tailwind_version" => nil,
+        "typescript_version" => nil,
+        "vue_router_version" => nil,
+        "vue_version" => nil
+      }
+    end
+
+    it { expect(extract).to eq(project_versions_extractor: expected) }
+
+    context "with valid files" do
+      let(:expected) do
+        {
+          "circleci_version" => "2",
+          "eslint_version" => "7.29.0",
+          "node_version" => "12",
+          "paperclip_version" => "5.0.0",
+          "rails_version" => "6.0.4",
+          "rubocop_version" => "1.18.0",
+          "shrine_version" => "3.4.0",
+          "sidekiq_version" => "6.2.2",
+          "stylelint_version" => "13.13.1",
+          "tailwind_version" => "2",
+          "typescript_version" => "4.5.5",
+          "vue_router_version" => "3.0.7",
+          "vue_version" => "2.6.14"
+        }
+      end
+
+      before do
+        mock_file_content("package.json", "valid_package_json")
+        mock_file_content("Gemfile.lock", "valid_gemfile_lock")
+        mock_file_content(".circleci/config.yml", "valid_circleci_config.yml")
+      end
+
+      it { expect(extract).to eq(project_versions_extractor: expected) }
+    end
+
+    context "with invalid files" do
+      before do
+        mock_file_content("package.json", "valid_gem_gemfile_lock")
+        mock_file_content("Gemfile.lock", "valid_gem_gemfile_lock")
+        mock_file_content(".circleci/config.yml", "valid_gem_gemfile_lock")
+      end
+
+      it { expect(extract).to eq(project_versions_extractor: expected) }
+    end
+  end
+end

data/spec/extractors/rails_best_practices_extractor_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::RailsBestPracticesExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:error) do
+      instance_double(
+        "RailsBestPractices::Core::Error",
+        filename: "spec/assets/test_project/app/controllers/team_controller.rb",
+        line_number: "4",
+        message: "move model logic into model (@team use_count > 4)",
+        type: "RailsBestPractices::Reviews::MoveModelLogicIntoModelReview",
+        url: "https://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/"
+      )
+    end
+
+    let(:errors) do
+      [
+        error
+      ]
+    end
+
+    let(:analyzer) do
+      instance_double(
+        "RailsBestPractices::Analyzer",
+        analyze: true,
+        errors: errors
+      )
+    end
+
+    let(:expected) do
+      {
+        "file_path" => "app/controllers/team_controller.rb:4",
+        "message" => "move model logic into model (@team use_count > 4)",
+        "type" => "Reviews::MoveModelLogicIntoModelReview",
+        "url" => "https://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/"
+      }
+    end
+
+    before do
+      allow(RailsBestPractices::Analyzer).to receive(:new).and_return(analyzer)
+    end
+
+    it { expect(extract[:rails_best_practices_extractor]["errors"].first).to eq(expected) }
+
+    context "without errors" do
+      let(:errors) do
+        []
+      end
+
+      it { expect(extract[:rails_best_practices_extractor]["errors"].count).to eq(0) }
+    end
+  end
+end

data/spec/extractors/rubocop_extractor_spec.rb

@@ -0,0 +1,113 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::RubocopExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:rubocop_result_content) do
+      {
+        "files" => [
+          {
+            "path" => "file1.rb",
+            "offenses" => [
+              {
+                "cop_name" => "Lint/UnderscorePrefixedVariableName",
+                "message" => "m1",
+                "severity" => "warning",
+                "location" => {
+                  "line" => 78,
+                  "column" => 33
+                }
+              },
+              {
+                "cop_name" => "Lint/UnderscorePrefixedVariableName",
+                "message" => "m2",
+                "severity" => "warning",
+                "location" => {
+                  "line" => 22,
+                  "column" => 1
+                }
+              }
+            ]
+          },
+          {
+            "path" => "file2.rb",
+            "offenses" => [
+              {
+                "cop_name" => "Lint/UnderscorePrefixedVariableName",
+                "message" => "m3",
+                "severity" => "warning",
+                "location" => {
+                  "line" => 60,
+                  "column" => 2
+                }
+              }
+            ]
+          },
+          {
+            "path" => "file3.rb",
+            "offenses" => [
+              {
+                "cop_name" => "Style/FrozenStringLiteralComment",
+                "message" => "Style/FrozenStringLiteralComment: m4",
+                "severity" => "convention",
+                "location" => {
+                  "line" => 66,
+                  "column" => 4
+                }
+              }
+            ]
+          }
+        ]
+      }.to_json
+    end
+
+    let(:runner) do
+      instance_double(
+        "RuboCop::Runner",
+        run: rubocop_result_content
+      )
+    end
+
+    let(:expected) do
+      {
+        "convention" => {
+          "Style/FrozenStringLiteralComment" => [
+            {
+              "message" => "m4",
+              "path" => "file3.rb:66:4"
+            }
+          ]
+        },
+        "warning" => {
+          "Lint/UnderscorePrefixedVariableName" => [
+            {
+              "message" => "m1",
+              "path" => "file1.rb:78:33"
+            },
+            {
+              "message" => "m2",
+              "path" => "file1.rb:22:1"
+            }, {
+              "message" => "m3",
+              "path" => "file2.rb:60:2"
+            }
+          ]
+        }
+      }
+    end
+
+    before do
+      allow(RuboCop::Runner).to receive(:new).and_return(runner)
+      allow(OutputUtils).to receive(:with_captured_stdout).and_return(rubocop_result_content)
+    end
+
+    it { expect(extract[:rubocop_extractor]["offenses"]).to eq(expected) }
+
+    context "with rubocop errors" do
+      before do
+        allow(RuboCop::Runner).to receive(:new).and_raise(RuboCop::Error)
+      end
+
+      it { expect(extract[:rubocop_extractor]["offenses"]).to eq({}) }
+    end
+  end
+end

data/spec/extractors/tests_info_extractor_spec.rb

@@ -0,0 +1,65 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::TestsInfoExtractor, repo_analyzer_extractor_helpers: true do
+  describe "#extract" do
+    let(:expected) do
+      {
+        "swagger_tests_count" => 1,
+        "system_tests_count" => 1,
+        "jest_tests_count" => 2,
+        "rails_code_coverage" => {
+          "controllers" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "mailers" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "models" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "jobs" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "policies" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "commands" => {
+            "files_count" => 1,
+            "tests_count" => 2
+          },
+          "services" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "observers" => {
+            "files_count" => 1,
+            "tests_count" => 0
+          },
+          "values" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "utils" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "clients" => {
+            "files_count" => 0,
+            "tests_count" => 0
+          },
+          "total" => {
+            "files_count" => 2,
+            "tests_count" => 2
+          }
+        }
+      }
+    end
+
+    it { expect(extract).to eq(tests_info_extractor: expected) }
+  end
+end

data/spec/jobs/repo_analyzer/extract_project_info_job_spec.rb

@@ -0,0 +1,50 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::ExtractProjectInfoJob, type: :job do
+  let(:repo_name) { "platanus/alisur-formulator" }
+
+  let(:files_list) do
+    "app/extractors/repo_analyzer/project_versions_extractor.rb"
+  end
+
+  let(:bridge) do
+    instance_double(
+      "RepoAnalyzer::ProjectDataBridge"
+    )
+  end
+
+  let(:extracted_data) do
+    {
+      project_versions_extractor: {
+        rails_version: "6.0"
+      }
+    }
+  end
+
+  let(:extractor) do
+    instance_double(
+      "RepoAnalyzer::ProjectVersionsExtractor",
+      extract: extracted_data
+    )
+  end
+
+  let(:engine_root) { instance_double("Pathname", join: files_list) }
+
+  def perform_now
+    described_class.perform_now(repo_name)
+  end
+
+  before do
+    allow(RepoAnalyzer::Engine).to receive(:root).and_return(engine_root)
+    allow(RepoAnalyzer::ProjectDataBridge).to receive(:new).and_return(bridge)
+    allow(RepoAnalyzer::ProjectVersionsExtractor).to receive(:new).and_return(extractor)
+  end
+
+  it { expect(perform_now).to eq(extracted_data) }
+
+  it do
+    perform_now
+    expect(RepoAnalyzer::ProjectDataBridge).to have_received(:new).with(repo_name).once
+    expect(RepoAnalyzer::ProjectVersionsExtractor).to have_received(:new).with(bridge).once
+  end
+end

data/spec/jobs/repo_analyzer/post_extracted_info_job_spec.rb

@@ -0,0 +1,52 @@
+require 'rails_helper'
+
+describe RepoAnalyzer::PostExtractedInfoJob, type: :job do
+  let(:project_info) do
+    {
+      "extracted" => "info"
+    }
+  end
+
+  let(:condition_result) { double }
+
+  let(:response) do
+    instance_double(
+      "Net::HTTPCreated",
+      is_a?: condition_result
+    )
+  end
+
+  let(:repo_name) { "hay-gas" }
+
+  let(:expected_post_data) do
+    {
+      repo_name: repo_name,
+      project_info: "eJyrVkqtKClKTC5JTVGyUsrMS8tXqgUATWwHKw==\n"
+    }.to_json
+  end
+
+  let(:nest_url) do
+    "https://platan.us/api/v1/repo_analyzer/project_info"
+  end
+
+  def perform_now
+    described_class.perform_now(repo_name, project_info)
+  end
+
+  before do
+    allow(Net::HTTP).to receive(:post).and_return(response)
+    allow(ENV).to receive(:[])
+      .with("REPO_ANALYZER_URL")
+      .and_return(nest_url)
+  end
+
+  it do
+    expect(perform_now).to eq(condition_result)
+    expect(Net::HTTP).to have_received(:post).with(
+      URI(nest_url),
+      expected_post_data,
+      "Content-Type" => "application/json"
+    ).once
+    expect(response).to have_received(:is_a?).with(Net::HTTPCreated).once
+  end
+end