add tests - wip - one error

Author: ABaldwinHunter

spec/cc/engine/analyzers/reporter_spec.rb

@@ -0,0 +1,54 @@
+require 'cc/engine/analyzers/javascript/main'
+require 'cc/engine/analyzers/reporter'
+require 'cc/engine/analyzers/engine_config'
+require 'cc/engine/analyzers/file_list'
+require 'flay'
+require 'tmpdir'
+
+RSpec.describe CC::Engine::Analyzers::Violation, in_tmpdir: true do
+  include AnalyzerSpecHelpers
+
+  before do
+    create_source_file("foo.js", <<-EOJS)
+      console.log("hello JS!");
+      console.log("hello JS!");
+      console.log("hello JS!");
+    EOJS
+  end
+
+  describe "#report" do
+    it "passes the correct parameters to Violation" do
+      expected_base_points = CC::Engine::Analyzers::Javascript::Main::BASE_POINTS
+      expected_per_points = CC::Engine::Analyzers::Javascript::Main::POINTS_PER
+      expected_threshold = 1
+      expected_issue = sample_flay_issue
+      expected_hashes = sample_hashes
+
+      expect(CC::Engine::Analyzers::Violation).to receive(:new).with(
+        expected_base_points,
+        expected_per_points,
+        expected_threshold,
+        expected_issue,
+        expected_hashes,
+      )
+
+      result = run_engine(engine_conf, CC::Engine::Analyzers::Javascript::Main).strip
+    end
+  end
+
+  def sample_hashes
+    [s(:ExpressionStatement, s(:expression, s(:CallExpression, s(:callee, s(:MemberExpression, s(:object, s(:Identifier, :console)), s(:property, s(:Identifier, :log)))), s(:arguments, s(:StringLiteral, :"hello JS!"))))), s(:ExpressionStatement, s(:expression, s(:CallExpression, s(:callee, s(:MemberExpression, s(:object, s(:Identifier, :console)), s(:property, s(:Identifier, :log)))), s(:arguments, s(:StringLiteral, :"hello JS!"))))), s(:ExpressionStatement, s(:expression, s(:CallExpression, s(:callee, s(:MemberExpression, s(:object, s(:Identifier, :console)), s(:property, s(:Identifier, :log)))), s(:arguments, s(:StringLiteral, :"hello JS!")))))]
+  end
+
+  def engine_conf
+    CC::Engine::Analyzers::EngineConfig.new({
+      'config' => {
+        'languages' => {
+          'javascript' => {
+            'mass_threshold' => 1
+          }
+        }
+      }
+    })
+  end
+end

spec/cc/engine/analyzers/violation_spec.rb

@@ -0,0 +1,52 @@
+require 'cc/engine/analyzers/javascript/main'
+require 'cc/engine/analyzers/reporter'
+require 'cc/engine/analyzers/engine_config'
+require 'cc/engine/analyzers/file_list'
+require 'flay'
+require 'tmpdir'
+
+RSpec.describe CC::Engine::Analyzers::Violation, in_tmpdir: true do
+  include AnalyzerSpecHelpers
+
+  describe "#format" do
+    it "returns correctly formatted issue" do
+
+      create_source_file("foo.js", <<-EOJS)
+          console.log("hello JS!");
+          console.log("hello JS!");
+          console.log("hello JS!");
+      EOJS
+
+      result = run_engine(engine_conf, CC::Engine::Analyzers::Javascript::Main).strip
+      json = JSON.parse(result)
+
+      expect(json["type"]).to eq("issue")
+      expect(json["check_name"]).to eq("Identical code")
+      expect(json["description"]).to eq("Similar code found in 2 other locations")
+      expect(json["categories"]).to eq(["Duplication"])
+      expect(json["location"]).to eq({
+        "path" => "foo.js",
+        "lines" => { "begin" => 1, "end" => 1 },
+      })
+      expect(json["remediation_points"]).to eq(6400000)
+      expect(json["other_locations"]).to eq([
+        {"path" => "foo.js", "lines" => { "begin" => 2, "end" => 2} },
+        {"path" => "foo.js", "lines" => { "begin" => 3, "end" => 3} }
+      ])
+      expect(json["content"]["body"]).to match /This issue has a mass of `99`/
+      expect(json["fingerprint"]).to eq("55ae5d0990647ef496e9e0d315f9727d")
+    end
+  end
+
+  def engine_conf
+    CC::Engine::Analyzers::EngineConfig.new({
+      'config' => {
+        'languages' => {
+          'javascript' => {
+            'mass_threshold' => 1
+          }
+        }
+      }
+    })
+  end
+end

spec/support/helpers/analyzer_spec_helpers.rb

@@ -3,14 +3,36 @@ def create_source_file(path, content)
     File.write(File.join(@code, path), content)
   end
 
-  def run_engine(config = nil)
+  def run_engine(config = nil, engine_class = described_class)
     io = StringIO.new
 
-    engine = described_class.new(engine_config: config)
+    engine = engine_class.new(engine_config: config)
     reporter = ::CC::Engine::Analyzers::Reporter.new(double(concurrency: 2), engine, io)
 
     reporter.run
 
     io.string
   end
+
+  def sample_flay_issue(
+      structural_hash = "bad8b06679434a129fbfc4034d9ddad7",
+      name = :ExpressionStatement,
+      bonus = "*3",
+      mass = 99,
+      locations = sample_locations
+    )
+    flay = Flay::Item.new(structural_hash, name, bonus, mass, locations)
+  end
+
+  def sample_locations
+    [
+      sample_flay_location("./foo.js", 1, nil),
+      sample_flay_location("./foo.js", 2, nil),
+      sample_flay_location("./foo.js", 3, nil),
+    ]
+  end
+
+  def sample_flay_location(file = "./foo.js", line = 1, fuzzy = nil)
+    Flay::Location.new(file, line, fuzzy)
+  end
 end