chat_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11bbd1390ca03c1f99d0ff66a5e3a361f259f40704575db73ae255e67e48b94b
+  data.tar.gz: 24781a89995cf1384962fb46b5a60d8ed5095e442af92162a85e5e82489007ee
+SHA512:
+  metadata.gz: a2584238466e94fc1efba40198f83761464f6bf399b9e99b8b640eb21a074a13699fe18bb42a4c1be049e1d0ccdb5950d721ce1342c04f1bfbc277f4195be189
+  data.tar.gz: f6e4ac759352ba03f7a21a283f3e43eb4202f0fad8ddd7125b1024713fe96bdac3b283a9bc3f5555495005c96bc92b5438307f55cf1b318556b79674c7143f32

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0
+
+### Added
+
+- Initial code

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2023 SOFware LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# ChatNotifier
+
+Notify a chat room with data from your test run.
+
+## Installation
+
+```
+gem "chat_notifier", git: "https://github.com/SOFware/chat_notifier.git"
+```
+
+## Usage
+
+Add to your `spec_helper.rb` or `rails_helper.rb`:
+
+```
+require "chat_notifier/rspec_formatter"
+```
+
+### Debug your Slack setup
+
+Create rake task to test the connection to your Slack channel
+
+```ruby
+namespace :chat_notifier do
+  task debug: :environment do
+    unless ENV["SLACK_WEBHOOK_URL"]
+      puts "You MUST set the environment variables for:\nSLACK_WEBHOOK_URL"
+      return
+    end
+    ENV["DEBUG"] = "1"
+    ENV["CURRENT_REPOSITORY_URL"] = "https://example.com"
+    ENV["TEST_RUN_ID"] = "9999"
+    require "chat_notifier"
+
+    failure = ChatNotifier::DebugExceptionLocation.new(location: "fake/path.rb")
+    summary = ChatNotifier::DebugSummary.new(failed_examples: [failure])
+
+    ChatNotifier.debug!(ENV, summary:)
+  end
+end
+```

data/lib/chat_notifier/chatter/debug.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class Chatter
+    class Debug < Slack
+      Chatter.register self
+
+      class << self
+        def handles?(settings)
+          !settings.keys.grep(/DEBUG/).empty?
+        end
+      end
+    end
+  end
+end

data/lib/chat_notifier/chatter/slack.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class Chatter
+    class Slack < self
+      Chatter.register self
+
+      class << self
+        def handles?(settings)
+          !settings.keys.grep(/SLACK/).empty?
+        end
+      end
+
+      def webhook_url
+        settings.fetch("SLACK_WEBHOOK_URL", nil)
+      end
+
+      def channel
+        settings.fetch("SLACK_NOTIFY_CHANNEL", nil)
+      end
+
+      def payload(data)
+        super(Configuration.for(data, self).to_h)
+      end
+
+      class Configuration
+        def self.for(messenger, communicator)
+          if messenger.failure?
+            FailureConfiguration
+          else
+            self
+          end.new(messenger, communicator).to_h
+        end
+
+        def initialize(messenger, communicator)
+          @messenger = messenger
+          @communicator = communicator
+        end
+        attr_reader :messenger, :communicator
+
+        def icon_emoji = ":green_circle:"
+
+        def to_h
+          {
+            channel: communicator.channel,
+            icon_emoji: icon_emoji
+          }.merge(messenger.to_h)
+        end
+
+        class FailureConfiguration < self
+          def icon_emoji = ":red_circle:"
+        end
+
+        private_constant :FailureConfiguration
+      end
+      private_constant :Configuration
+    end
+  end
+end

data/lib/chat_notifier/chatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module ChatNotifier
+  # All behavior for interacting with a notification platform
+  class Chatter
+    def initialize(settings:, repository:, environment:)
+      @settings = settings
+      @repository = repository
+      @environment = environment
+    end
+
+    attr :settings, :repository, :environment
+
+    class << self
+      def handlers
+        @handlers ||= []
+      end
+
+      def handles?
+        false
+      end
+
+      def register(klass)
+        handlers << klass
+      end
+
+      def handling(settings, repository:, environment:)
+        handlers.select { |handler| handler.handles?(settings) }.map do |klass|
+          klass.new(
+            settings: settings,
+            repository: repository,
+            environment: environment
+          )
+        end
+      end
+    end
+
+    def webhook_url
+    end
+
+    def body
+    end
+
+    def post(messenger)
+      uri = URI(webhook_url)
+
+      Net::HTTP.post(uri, payload(messenger))
+    end
+
+    def conditional_post(messenger)
+      return if messenger.success? && !verbose?
+
+      post(messenger)
+    end
+
+    def verbose?
+      !!settings.fetch("NOTIFIER_VERBOSE", false)
+    end
+
+    def payload(data)
+      data.to_json
+    end
+  end
+end
+
+require_relative "chatter/slack"
+require_relative "chatter/debug"

data/lib/chat_notifier/messenger.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module ChatNotifier
+  class Messenger
+    extend Forwardable
+
+    class << self
+      def for(summary, repository:, environment:, app:)
+        if summary.failed_examples.empty?
+          self
+        else
+          Failure
+        end.new(
+          summary:,
+          app:,
+          repository:,
+          environment:
+        )
+      end
+
+      def debug=(val)
+        prepend Debug if val
+      end
+    end
+
+    module Debug
+      def message = "This is only a test…"
+    end
+
+    def initialize(summary:, app:, repository:, environment:)
+      @summary = summary
+      @app = app
+      @repository = repository
+      @environment = environment
+    end
+
+    attr :summary, :app, :repository, :environment
+
+    def failures = summary.failed_examples
+
+    def_delegator :failures, :count
+    def_delegators :app, :branch, :sha
+    def_delegator :environment, :ruby_version
+
+    def message
+      "#{message_prefix} #{identifier} is OK on branch #{repository.link(branch)}"
+    end
+
+    def lede = message
+
+    def body = ""
+
+    def identifier
+      "#{app} #{ruby_version} #{sha}"
+    end
+
+    def message_prefix = ":thumbsup:"
+
+    def success? = true
+
+    def failure? = !success?
+
+    def to_h
+      {
+        text: message
+      }
+    end
+
+    def to_hash = to_h
+
+    class Failure < self
+      def count = "#{failures.size} times!"
+
+      def message_prefix = ":boom:"
+
+      def success? = false
+
+      def failure? = !success?
+
+      def lede
+        <<~LEDE.chomp
+          #{message_prefix} #{identifier} has failed #{count} in #{branch}
+
+          #{environment.test_run_url}
+        LEDE
+      end
+
+      def message
+        <<~MESSAGE.chomp
+          #{lede}
+
+          #{body}
+        MESSAGE
+      end
+
+      def body
+        failures.flat_map(&:location).join("\n")
+      end
+    end
+  end
+end

data/lib/chat_notifier/repository/debug.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class Repository
+    class Debug < self
+      def url
+        "http://example.com"
+      end
+
+      def link(sha)
+        "#{url}/tree/#{sha}"
+      end
+    end
+  end
+end

data/lib/chat_notifier/repository/github.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class Repository
+    class Github < self
+      def url
+        settings.fetch("CURRENT_REPOSITORY_URL", nil)
+      end
+
+      def link(sha)
+        "#{url}/tree/#{sha}"
+      end
+    end
+  end
+end

data/lib/chat_notifier/repository.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  # All information about the location of the source code
+  class Repository
+    def initialize(settings:)
+      @settings = settings
+    end
+
+    attr_reader :settings
+
+    def self.for(settings)
+      if settings["DEBUG"]
+        Debug
+      else
+        Github
+      end.new(settings: settings)
+    end
+
+    def link(_sha)
+    end
+  end
+end
+
+require_relative "repository/github"
+require_relative "repository/debug"

data/lib/chat_notifier/rspec_formatter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rspec/core/formatters"
+RSpec::Support.require_rspec_core "formatters/base_formatter"
+
+require "chat_notifier"
+
+module ChatNotifier
+  # Formatter for RSpec tests to receive the summary of a test
+  # run after the suite has finished.
+  class RspecFormatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self, :dump_summary
+
+    def dump_summary(summary)
+      ChatNotifier.call(summary:)
+    end
+  end
+end

data/lib/chat_notifier/test_environment/debug.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class TestEnvironment
+    class Debug < self
+      def url
+        "http://example.com"
+      end
+
+      def test_run_url
+        "#{url}/test-run/9999999"
+      end
+    end
+  end
+end

data/lib/chat_notifier/test_environment/github.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  class TestEnvironment
+    class Github < self
+      def test_run_url
+        "#{url}/actions/runs/#{run_id}"
+      end
+
+      def run_id
+        settings.fetch("TEST_RUN_ID")
+      end
+    end
+  end
+end

data/lib/chat_notifier/test_environment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  # All information about the place where the test was run
+  class TestEnvironment
+    def initialize(settings:)
+      @settings = settings
+    end
+
+    attr_reader :settings
+
+    def self.for(settings)
+      if settings["DEBUG"]
+        Debug
+      else
+        Github
+      end.new(settings: settings)
+    end
+
+    def ruby_version
+      "Ruby #{::RUBY_VERSION}"
+    end
+
+    def url
+      settings.fetch("CURRENT_REPOSITORY_URL")
+    end
+
+    def test_run_url
+    end
+  end
+end
+
+require_relative "test_environment/github"
+require_relative "test_environment/debug"

data/lib/chat_notifier/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  VERSION = "0.1.0"
+end

data/lib/chat_notifier.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "chat_notifier/version"
+
+require_relative "chat_notifier/messenger"
+require_relative "chat_notifier/repository"
+require_relative "chat_notifier/test_environment"
+require_relative "chat_notifier/chatter"
+
+module ChatNotifier
+  DebugExceptionLocation = Data.define(:location)
+  DebugSummary = Data.define(:failed_examples)
+
+  class << self
+    # In order to test this locally see `rake chat_notifier:debug`
+    def debug!(env, summary:, notifier: :Debug)
+      repository = Repository.for(env)
+      environment = TestEnvironment.for(env)
+
+      chatter = Chatter.const_get(notifier).new(
+        settings: env,
+        repository: repository,
+        environment: environment
+      )
+      messenger = Messenger.for(
+        summary,
+        app: Rails.application.class.module_parent,
+        repository: repository,
+        environment: environment
+      )
+
+      chatter.post(messenger)
+    end
+
+    def call(summary:)
+      repository = Repository.for(ENV)
+      environment = TestEnvironment.for(ENV)
+      chatter = Chatter.handling(
+        ENV,
+        repository:,
+        environment:
+      )
+
+      messenger = Messenger.for(
+        summary,
+        app: Rails.application.class.module_parent,
+        repository:,
+        environment:
+      )
+
+      chatter.each do |box|
+        box.conditional_post(messenger)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chat_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Send test results to chat
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/chat_notifier.rb
+- lib/chat_notifier/chatter.rb
+- lib/chat_notifier/chatter/debug.rb
+- lib/chat_notifier/chatter/slack.rb
+- lib/chat_notifier/messenger.rb
+- lib/chat_notifier/repository.rb
+- lib/chat_notifier/repository/debug.rb
+- lib/chat_notifier/repository/github.rb
+- lib/chat_notifier/rspec_formatter.rb
+- lib/chat_notifier/test_environment.rb
+- lib/chat_notifier/test_environment/debug.rb
+- lib/chat_notifier/test_environment/github.rb
+- lib/chat_notifier/version.rb
+homepage:
+licenses: []
+metadata:
+  source_code_uri: https://github.com/SOFware/chat_notifier.git
+  changelog_uri: https://github.com/SOFWare/chat_notifier/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Notify chat of test results
+test_files: []