redmine-mattermost 0.3 → 0.4.beta1

data/spec/extractors/updated_issue_spec.rb

@@ -0,0 +1,169 @@
+require "spec_helper"
+
+describe RedmineMattermost::Extractors::UpdatedIssue do
+  subject { RedmineMattermost::Extractors::UpdatedIssue.new(bridge) }
+  let(:result) { subject.from_context(context) }
+  let(:msg)    { result[:message] }
+  let(:context) do
+    { issue: issue, journal: journal }
+  end
+  let(:bridge)  { MockBridge.new(settings) }
+  let(:issue)   { MockIssue.new(issue_data) }
+  let(:journal) { mock(journal_data) }
+
+  let(:settings) { Defaults.settings }
+  let(:issue_data) do
+    {
+      title: "Some title",
+      project: EventMock.new(title: "Project A")
+    }
+  end
+  let(:journal_data) { Hash.new }
+
+  describe "empty context" do
+    let(:context) { Hash.new }
+
+    it "raises" do
+      proc { result }.must_raise KeyError
+    end
+  end
+
+  describe "no project" do
+    let(:issue_data) do
+      {
+        title: "Some title"
+      }
+    end
+
+    it "returns nil" do
+      result.must_be_nil
+    end
+  end
+
+  describe "minimal journal" do
+    let(:journal_data) do
+      {
+        details: [],
+        user: mock(title: "User A")
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A updated #{link_for("Some title")}"
+      )
+    end
+  end
+
+  describe "full journal" do
+    let(:journal_data) do
+      {
+        details: [
+          mock(prop_key: "title", value: "Some title"),
+          mock(prop_key: "subject", value: "Some subject"),
+          mock(prop_key: "description", value: "Some description"),
+          mock(prop_key: "tracker_id", value: 1),
+          mock(prop_key: "project_id", value: 1),
+          mock(prop_key: "status_id", value: 1),
+          mock(prop_key: "priority_id", value: 1),
+          mock(prop_key: "category_id", value: 1),
+          mock(prop_key: "assigned_to", value: 1),
+          mock(prop_key: "fixed_version", value: 1),
+          mock(property: "attachment", prop_key: 1),
+          mock(prop_key: "parent_id", value: 1),
+          mock(prop_key: "other", value: "Some other"),
+          mock(property: "cf", prop_key: "empty_cf"),
+          mock(property: "cf", prop_key: "other_cf", value: "Some value")
+        ],
+        user: mock(title: "User A"),
+        notes: "This is a @note@"
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A updated #{link_for("Some title")}"
+      )
+
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+      text        = attachment[:text]
+      text.must_equal "This is a `note`"
+      fields      = attachment[:fields]
+      fields.size.must_equal 15
+      fields.shift.must_equal({
+        title: "field_title",
+        value: "Some title"
+      })
+      fields.shift.must_equal({
+        title: "field_subject",
+        value: "Some subject"
+      })
+      fields.shift.must_equal({
+        title: "field_description",
+        value: "Some description"
+      })
+      fields.shift.must_equal({
+        title: "field_tracker",
+        value: "Tracker: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_project",
+        value: "Project: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_status",
+        value: "IssueStatus: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_priority",
+        value: "IssuePriority: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_category",
+        value: "IssueCategory: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_assigned_to",
+        value: "User: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_fixed_version",
+        value: "Version: 1",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "label_attachment",
+        value: link_for("file_1.png"),
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_parent",
+        value: link_for("Issue: 1"),
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_other",
+        value: "Some other",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "CustomField empty_cf",
+        value: "-",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "CustomField other_cf",
+        value: "Some value",
+        short: true
+      })
+    end
+  end
+end

data/spec/message_builder_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe RedmineMattermost::MessageBuilder do
+  subject    { RedmineMattermost::MessageBuilder.new(text) }
+  let(:text) { "Some message" }
+  let(:expected) do
+    {
+      link_names: 1,
+      text: text
+    }
+  end
+  it "returns the text as default" do
+    result.must_equal(expected)
+  end
+
+  it "sets the username" do
+    subject.username("TestUser")
+    result.must_equal(expected.merge({
+      username: "TestUser"
+    }))
+  end
+
+  it "sets the channel" do
+    subject.channel("the-channel")
+    result.must_equal(expected.merge({
+      channel: "the-channel"
+    }))
+  end
+
+  it "adds attachments" do
+    subject.attachment.text("the text")
+    subject.attachment.text("other text")
+      .field("title", "value")
+      .field("foo", "bar", true)
+
+    result.must_equal(expected.merge({
+      attachments: [
+        {
+          text: "the text"
+        },
+        {
+          text: "other text",
+          fields: [
+            {
+              title: "title",
+              value: "value"
+            },
+            {
+              title: "foo",
+              value: "bar",
+              short: true
+            }
+          ]
+        }
+      ]
+    }))
+  end
+
+  it "set the icon as url" do
+    subject.icon("http://some.com/test.png")
+    result.must_equal(expected.merge({
+      icon_url: "http://some.com/test.png"
+    }))
+  end
+
+  private
+
+  def result
+    subject.to_hash
+  end
+end

data/spec/redmine_mattermost_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe RedmineMattermost do
+  subject { RedmineMattermost }
+
+  it "has a version" do
+    subject::VERSION.wont_be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "redmine-mattermost"
+
+require "minitest/autorun"
+require "webmock/minitest"
+
+require_relative "support/mock_support"
+
+class Minitest::Test
+  def mock(data)
+    Mock.new(data)
+  end
+
+  def link_for(label)
+    '<URL: {"host":"test.host","protocol":"http","port":null,' \
+    '"script_name":null}|' + label + '>'
+  end
+end

data/spec/support/mock_support.rb

@@ -0,0 +1,113 @@
+require "ostruct"
+require "redcloth"
+
+class Mock < OpenStruct
+  def to_s
+    title
+  end
+end
+
+class EventMock < Mock
+  def event_url(options)
+    "URL: #{options.to_json}"
+  end
+end
+
+class MockIssue < EventMock
+  def is_private?
+    is_private
+  end
+
+  def valid?
+    valid
+  end
+end
+
+class MockBridge
+  attr_reader :settings
+
+  def initialize(settings)
+    @settings = settings
+  end
+
+  def custom_field_by_name(name)
+    OpenStruct.new(name: name)
+  end
+
+  def url_for(target)
+    target
+  end
+
+  def translate(key, options)
+    options[:locale].must_equal(settings.default_language)
+    key
+  end
+
+  def to_html(formatting, text)
+    RedCloth.new(text).to_html
+  end
+
+  def find_custom_field(id)
+    Mock.new(name: "CustomField #{id}")
+  end
+
+  def find_tracker(id)
+    "Tracker: #{id}"
+  end
+
+  def find_project(id)
+    "Project: #{id}"
+  end
+
+  def find_issue_status(id)
+    "IssueStatus: #{id}"
+  end
+
+  def find_issue_priority(id)
+    "IssuePriority: #{id}"
+  end
+
+  def find_issue_category(id)
+    "IssueCategory: #{id}"
+  end
+
+  def find_user(id)
+    "User: #{id}"
+  end
+
+  def find_version(id)
+    "Version: #{id}"
+  end
+
+  def find_attachement(id)
+    MockIssue.new(title: "Attachment: #{id}", filename: "file_#{id}.png")
+  end
+
+  def find_issue(id)
+    MockIssue.new(title: "Issue: #{id}")
+  end
+end
+
+class Defaults
+  def self.settings
+    Mock.new({
+      host_name: "https://test.host",
+      protocol: "http",
+      port: 80,
+      script_name: "some_script",
+      plugin_redmine_mattermost: plugin_settings,
+      text_formatting: "textile",
+      default_language: "en"
+    })
+  end
+
+  def self.plugin_settings
+    {
+      display_watchers: "1",
+      post_updates: "1",
+      post_wiki_updates: "1",
+      mattermost_url: "http://api.mattermost.org",
+      channel: "fallback-channel"
+    }
+  end
+end

data/spec/utils/text_spec.rb

@@ -0,0 +1,142 @@
+require "spec_helper"
+
+describe RedmineMattermost::Utils::Text do
+  subject        { Dummy.new(bridge) }
+  let(:bridge)   { MockBridge.new(settings) }
+  let(:settings) { Defaults.settings }
+
+  describe "h" do
+    it "escapes special chars" do
+      text = subject.h("some & special <chars>")
+      text.must_equal("some &amp; special &lt;chars&gt;")
+    end
+
+    it "handles nil inputs" do
+      subject.h(nil).must_be_nil
+    end
+  end
+
+  describe "link" do
+    it "builds a markdown link" do
+      text = subject.link("the < label", "the_target")
+      text.must_equal("<the_target|the &lt; label>")
+    end
+  end
+
+  describe "to_markdown" do
+    it "transforms HTML" do
+      input = <<HTML.strip
+<h1>Header1</h1>
+<h2>Header2</h2>
+<p>This is a new comment</p>
+<ul>
+<li>with multiple items</li>
+<li>in a list</li>
+</ul>
+
+<p>or a</p>
+
+<ol>
+<li>Numbered</li>
+<li>List</li>
+</ol>
+
+<p>
+<del>strike</del> <ins>underline</ins> <em>italic</em> <strong>bold</strong>
+</p>
+
+<blockquote>
+<p>Block quote</p>
+</blockquote>
+
+<p>
+<img src="https://www.example.org/image.png" alt="Example Image">
+</p>
+
+<p>
+External link: <a href="https://www.example.org" class="external">ExampleORG</a>
+</p>
+
+<pre>
+Some pre-indented text
+in two lines
+</pre>
+
+<pre><code class="ruby syntaxhl">
+class Ruby
+end
+</code></pre>
+
+HTML
+      expected = <<MARKDOWN.strip
+# Header1
+
+## Header2
+
+This is a new comment
+
+- with multiple items
+- in a list
+
+or a
+
+1. Numbered
+2. List
+
+~~strike~~ underline _italic_ **bold**
+
+> Block quote
+
+![Example Image](https://www.example.org/image.png)
+
+External link: [ExampleORG](https://www.example.org)
+
+```
+Some pre-indented text
+in two lines
+```
+
+```
+class Ruby
+end
+```
+MARKDOWN
+      text = subject.to_markdown(input)
+      text.must_equal(expected)
+    end
+
+    it "passes already used markdown" do
+      settings.text_formatting = "markdown"
+      text = subject.to_markdown("> Markdown")
+      text.must_equal("> Markdown")
+    end
+
+    it "rescues to escaped test" do
+      stub = proc do |formatting, text|
+        raise "some error"
+      end
+      bridge.stub(:to_html, stub) do
+        text = subject.to_markdown("<code>")
+        text.must_equal("&lt;code&gt;")
+      end
+    end
+  end
+
+  private
+
+  class Dummy
+    include RedmineMattermost::Utils::Text
+
+    attr_reader :bridge
+
+    def initialize(bridge)
+      @bridge = bridge
+    end
+
+    # just use the input (assuming the test already)
+    # provides valid HTML
+    def to_html(formatting, text)
+      text
+    end
+  end
+end