Make sure the format for the Slack notifications is correct.

Author: calavera

lib/cc/formatters/snapshot_formatter.rb

@@ -42,21 +42,21 @@ class Base
       attr_reader :alert_constants_payload, :improved_constants_payload, :details_url, :compare_url
 
       def initialize(payload)
-        new_constants = Array(payload[:new_constants])
-        changed_constants = Array(payload[:changed_constants])
+        new_constants = Array(payload["new_constants"])
+        changed_constants = Array(payload["changed_constants"])
 
         alert_constants = new_constants.select(&new_constants_selector)
         alert_constants += changed_constants.select(&decreased_constants_selector)
 
         improved_constants = changed_constants.select(&improved_constants_selector)
 
         data = {
-          from: { commit_sha: payload[:previous_commit_sha] },
-          to:   { commit_sha: payload[:commit_sha] }
+          "from" => { "commit_sha" => payload["previous_commit_sha"] },
+          "to"   => { "commit_sha" => payload["commit_sha"] }
         }
 
-        @alert_constants_payload    = data.merge(constants: alert_constants) if alert_constants.any?
-        @improved_constants_payload = data.merge(constants: improved_constants) if improved_constants.any?
+        @alert_constants_payload    = data.merge("constants" => alert_constants) if alert_constants.any?
+        @improved_constants_payload = data.merge("constants" => improved_constants) if improved_constants.any?
       end
 
     private
@@ -74,11 +74,11 @@ def improved_constants_selector
       end
 
       def to_rating(constant)
-        Rating.new(constant[:to][:rating])
+        Rating.new(constant["to"]["rating"])
       end
 
       def from_rating(constant)
-        Rating.new(constant[:from][:rating])
+        Rating.new(constant["from"]["rating"])
       end
     end
 

lib/cc/helpers/quality_helper.rb

@@ -36,7 +36,7 @@ def with_article(letter, bold = false)
 
   def constant_basename(name)
     if name.include?(".")
-      file.basename(name)
+      File.basename(name)
     else
       name
     end

lib/cc/services/slack.rb

@@ -1,6 +1,8 @@
  # encoding: UTF-8
 
 class CC::Service::Slack < CC::Service
+  include CC::Service::QualityHelper
+
   class Config < CC::Service::Config
     attribute :webhook_url, String,
       label: "Webhook URL",
@@ -57,35 +59,32 @@ def speak(message, color = nil)
     http_post(config.webhook_url, body.to_json)
   end
 
-  def send_snapshot_to_slack(payload, sample = false)
-    snapshot = SnapshotEventFormatter.new(repo, payload, sample)
-
-    if formatter.alert_constants_payload
-      speak(alerts_message(snapshot), RED_HEX)
+  def send_snapshot_to_slack(snapshot)
+    if snapshot.alert_constants_payload
+      speak(alerts_message(snapshot.alert_constants_payload), RED_HEX)
     end
 
-    if formatter.improved_constants_payload
-      speak(improvements_message(snapshot), GREEN_HEX)
+    if snapshot.improved_constants_payload
+      speak(improvements_message(snapshot.improved_constants_payload), GREEN_HEX)
     end
   end
 
-  def alert_message(snapshot)
-    constants = snapshot.alert_constants_payload
-
-    message = ["Quality alert triggered for *#{repo_identifier}* (<#{compare_url}|Compare>)\n"]
+  def alerts_message(constants_payload)
+    constants = constants_payload["constants"]
+    message = ["Quality alert triggered for *#{repo_name}* (<#{compare_url}|Compare>)\n"]
 
     constants[0..2].each do |constant|
       object_identifier = constant_basename(constant["name"])
 
       if constant["from"]
-        from_rating = from_rating(constant)
-        to_rating = to_rating(constant)
+        from_rating = constant["from"]["rating"]
+        to_rating   = constant["to"]["rating"]
 
         message << "• _#{object_identifier}_ just declined from #{with_article(from_rating, :bold)} to #{with_article(to_rating, :bold)}"
       else
-        rating = to_rating(constant)
+        rating = constant["to"]["rating"]
 
-        message << "• _#{object_identifier}_ was just created and is #{with_article(rating, :bold)} *#{rating}*"
+        message << "• _#{object_identifier}_ was just created and is #{with_article(rating, :bold)}"
       end
     end
 
@@ -97,15 +96,14 @@ def alert_message(snapshot)
     message.join("\n")
   end
 
-  def improvement_message(snapshot)
-    constants = snapshot.improved_constants_payload
-
-    message = ["Quality improvements in *#{repo_identifier}* (<#{compare_url}|Compare>)\n"]
+  def improvements_message(constants_payload)
+    constants = constants_payload["constants"]
+    message = ["Quality improvements in *#{repo_name}* (<#{compare_url}|Compare>)\n"]
 
     constants[0..2].each do |constant|
       object_identifier = constant_basename(constant["name"])
-      from_rating = from_rating(constant)
-      to_rating = to_rating(constant)
+      from_rating = constant["from"]["rating"]
+      to_rating   = constant["to"]["rating"]
 
       message << "• _#{object_identifier}_ just improved from #{with_article(from_rating, :bold)} to #{with_article(to_rating, :bold)}"
     end

test/formatters/snapshot_formatter_test.rb

@@ -6,39 +6,39 @@ def described_class
   end
 
   def test_quality_alert_with_new_constants
-    f = described_class.new({new_constants: [{to: {rating: "D"}}], changed_constants: []})
+    f = described_class.new({"new_constants" => [{"to" => {"rating" => "D"}}], "changed_constants" => []})
     refute_nil f.alert_constants_payload
   end
 
   def test_quality_alert_with_decreased_constants
-    f = described_class.new({new_constants: [],
-                                  changed_constants: [{to: {rating: "D"}, from: {rating: "A"}}]
+    f = described_class.new({"new_constants" => [],
+                             "changed_constants" => [{"to" => {"rating" => "D"}, "from" => {"rating" => "A"}}]
     })
     refute_nil f.alert_constants_payload
   end
 
   def test_quality_improvements_with_better_ratings
-    f = described_class.new({new_constants: [],
-                                  changed_constants: [{to: {rating: "A"}, from: {rating: "D"}}]
+    f = described_class.new({"new_constants" => [],
+                             "changed_constants" => [{"to" => {"rating" => "A"}, "from" => {"rating" => "D"}}]
     })
     refute_nil f.improved_constants_payload
   end
 
   def test_nothing_set_without_changes
-    f = described_class.new({new_constants: [], changed_constants: []})
+    f = described_class.new({"new_constants" => [], "changed_constants" => []})
     assert_nil f.alert_constants_payload
     assert_nil f.improved_constants_payload
   end
 
   def test_snapshot_formatter_test_with_relaxed_constraints
     f = CC::Formatters::SnapshotFormatter::Sample.new({
-       new_constants: [{name: "foo", to: {rating: "A"}}, {name: "bar", to: {rating: "A"}}],
-       changed_constants: [
-         {from: {rating: "B"}, to: {rating: "C"}},
-         {from: {rating: "D"}, to: {rating: "D"}},
-         {from: {rating: "D"}, to: {rating: "D"}},
-         {from: {rating: "A"}, to: {rating: "B"}},
-         {from: {rating: "C"}, to: {rating: "B"}}
+       "new_constants" => [{"name" => "foo", "to" => {"rating" => "A"}}, {"name" => "bar", "to" => {"rating" => "A"}}],
+       "changed_constants" => [
+         {"from" => {"rating" => "B"}, "to" => {"rating" => "C"}},
+         {"from" => {"rating" => "D"}, "to" => {"rating" => "D"}},
+         {"from" => {"rating" => "D"}, "to" => {"rating" => "D"}},
+         {"from" => {"rating" => "A"}, "to" => {"rating" => "B"}},
+         {"from" => {"rating" => "C"}, "to" => {"rating" => "B"}}
        ]})
 
     refute_nil f.alert_constants_payload

test/slack_test.rb

@@ -72,6 +72,96 @@ def test_multiple_vulnerabilities
     ].join(" "))
   end
 
+  def test_quality_alert_with_new_constants
+    data = { "name" => "snapshot", "repo_name" => "Rails",
+             "new_constants" => [{"name" => "Foo", "to" => {"rating" => "D"}}, {"name" => "bar.js", "to" => {"rating" => "F"}}],
+             "changed_constants" => [],
+             "compare_url" => "https://codeclimate.com/repos/1/compare/a...z" }
+
+    assert_slack_receives(CC::Service::Slack::RED_HEX, data,
+"""Quality alert triggered for *Rails* (<https://codeclimate.com/repos/1/compare/a...z|Compare>)
+
+• _Foo_ was just created and is a *D*
+• _bar.js_ was just created and is an *F*""")
+  end
+
+  def test_quality_alert_with_new_constants_and_declined_constants
+    data = { "name" => "snapshot", "repo_name" => "Rails",
+             "new_constants" => [{"name" => "Foo", "to" => {"rating" => "D"}}],
+             "changed_constants" => [{"name" => "bar.js", "from" => {"rating" => "A"}, "to" => {"rating" => "F"}}],
+             "compare_url" => "https://codeclimate.com/repos/1/compare/a...z" }
+
+    assert_slack_receives(CC::Service::Slack::RED_HEX, data,
+"""Quality alert triggered for *Rails* (<https://codeclimate.com/repos/1/compare/a...z|Compare>)
+
+• _Foo_ was just created and is a *D*
+• _bar.js_ just declined from an *A* to an *F*""")
+  end
+
+  def test_quality_alert_with_new_constants_and_declined_constants_overflown
+    data = { "name" => "snapshot", "repo_name" => "Rails",
+             "new_constants" => [{"name" => "Foo", "to" => {"rating" => "D"}}],
+             "changed_constants" => [
+               {"name" => "bar.js", "from" => {"rating" => "A"}, "to" => {"rating" => "F"}},
+               {"name" => "baz.js", "from" => {"rating" => "B"}, "to" => {"rating" => "D"}},
+               {"name" => "Qux",    "from" => {"rating" => "A"}, "to" => {"rating" => "D"}}
+             ],
+             "compare_url" => "https://codeclimate.com/repos/1/compare/a...z",
+             "details_url" => "https://codeclimate.com/repos/1/feed"
+    }
+
+
+    assert_slack_receives(CC::Service::Slack::RED_HEX, data,
+"""Quality alert triggered for *Rails* (<https://codeclimate.com/repos/1/compare/a...z|Compare>)
+
+• _Foo_ was just created and is a *D*
+• _bar.js_ just declined from an *A* to an *F*
+• _baz.js_ just declined from a *B* to a *D*
+
+And <https://codeclimate.com/repos/1/feed|1 other change>""")
+  end
+
+  def test_quality_improvements
+    data = { "name" => "snapshot", "repo_name" => "Rails",
+             "new_constants" => [],
+             "changed_constants" => [
+               {"name" => "bar.js", "from" => {"rating" => "F"}, "to" => {"rating" => "A"}},
+             ],
+             "compare_url" => "https://codeclimate.com/repos/1/compare/a...z",
+             "details_url" => "https://codeclimate.com/repos/1/feed"
+    }
+
+
+    assert_slack_receives(CC::Service::Slack::GREEN_HEX, data,
+"""Quality improvements in *Rails* (<https://codeclimate.com/repos/1/compare/a...z|Compare>)
+
+• _bar.js_ just improved from an *F* to an *A*""")
+  end
+
+  def test_quality_improvements_overflown
+    data = { "name" => "snapshot", "repo_name" => "Rails",
+             "new_constants" => [],
+             "changed_constants" => [
+               {"name" => "Foo",    "from" => {"rating" => "F"}, "to" => {"rating" => "A"}},
+               {"name" => "bar.js", "from" => {"rating" => "D"}, "to" => {"rating" => "B"}},
+               {"name" => "baz.js", "from" => {"rating" => "D"}, "to" => {"rating" => "A"}},
+               {"name" => "Qux",    "from" => {"rating" => "F"}, "to" => {"rating" => "A"}},
+             ],
+             "compare_url" => "https://codeclimate.com/repos/1/compare/a...z",
+             "details_url" => "https://codeclimate.com/repos/1/feed"
+    }
+
+
+    assert_slack_receives(CC::Service::Slack::GREEN_HEX, data,
+"""Quality improvements in *Rails* (<https://codeclimate.com/repos/1/compare/a...z|Compare>)
+
+• _Foo_ just improved from an *F* to an *A*
+• _bar.js_ just improved from a *D* to a *B*
+• _baz.js_ just improved from a *D* to an *A*
+
+And <https://codeclimate.com/repos/1/feed|1 other improvement>""")
+  end
+
   private
 
   def assert_slack_receives(color, event_data, expected_body)