rspec-log_matcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cff49aaad12c7e78ee918b21bba1e19d609b5098d0da6dfad8d58a91f64dd23
+  data.tar.gz: d19d360da5c337292ca0e85a15de74a080cc4ecc1469118fad5a96c7a64f44e2
+SHA512:
+  metadata.gz: a284eb8e2aa71e6a6f69b0b7fbd3c5f68cabab1a5713845b456641070d42c022039d8bbfcc14819d3167e15e27b8d1d548ee7a089df7244143110762aa226367
+  data.tar.gz: '08cde836ee3666ea3f5133e535ca27f263fee6de0906681e8838e6a1b7c49d5c2892ea54fbe626a023bd31698ff9c23e7a5cba8a8035651651b6d815a67130d2'

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# master
+
+# 1.0.0
+
+* Log matcher added
+
+    *Juan Manuel Ramallo*

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Juan Manuel Ramallo
+
+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,114 @@
+# RSpec::LogMatcher
+
+## What is this?
+An RSpec custom matcher to test code that logs information into log files.
+
+Writing logs is an easy way to store any kind of information for further analysis later on. It's commonly used to store analytics events and then make the logs a data source for data engineering tasks. This matcher makes application-logging-testing easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'rspec-log_matcher'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+### Plain old ruby objects
+
+```ruby
+# app/services/payment_service.rb
+class PaymentService
+  def self.call
+    # [snip]
+
+    logger.info "event=payment-successful properties=#{data.to_json}"
+  end
+end
+```
+
+```ruby
+# spec/services/payment_service_spec.rb
+require 'spec_helper'
+
+RSpec.describe PaymentService
+  describe '.call' do
+    subject { described_class.call }
+
+    it 'logs event information' do
+      expect { subject }.to log("event=payment-successful properties=#{build_expected_json}")
+    end
+  end
+end
+```
+
+### Request specs
+```ruby
+# spec/requests/users_spec.rb
+require 'spec_helper'
+
+RSpec.describe 'Users' do
+    describe 'GET /index' do
+        expect { get(users_path) }.to log('Page view - Users index')
+    end
+end
+```
+
+### Feature specs
+
+```ruby
+# spec/features/sign_in_spec.rb
+require 'spec_helper'
+
+RSpec.feature 'Sign in' do
+  scenario 'successful sign in' do
+    user = create(:user)
+
+    visit sign_in_path
+    fill_form(user)
+    submit_form
+
+    expect(page).to have_text('Welcome!')
+    expect(page).to log("User #{user.id} has logged in")
+  end
+end
+```
+
+Regular expressions and procs are also valid object types for the expected logs, for more use cases refer to the [spec file](https://github.com/juanmanuelramallo/rspec-log_matcher/blob/master/spec/rspec-log_matcher_spec.rb).
+
+## Configuration
+
+The default path for the log file is `log/test.log`. It can be configured via an environment variable called `LOG_PATH`.
+
+This is useful when tests are run parallely, and each process has their own log file.
+
+## How it works?
+
+The matcher reads into the log file and looks for the expected logs to be present in the log file.
+
+When the subject is a proc, the matcher will execute proc and compare against the logs introduced by the proc execution.
+
+When the subject is a Capybara::Session (from a feature spec, system tests), the matcher will store the position in the file to the last byte in a before hook. Then, when the example is run, it will compare against the changes introduced by the example using the position stored as the beginning of the logs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/juanmanuelramallo/rspec-log_matcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/juanmanuelramallo/rspec-log_matcher/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rspec::LogMatcher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/juanmanuelramallo/rspec-log_matcher/blob/master/CODE_OF_CONDUCT.md).

data/lib/rspec-log_matcher.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rspec/log_matcher'
+
+module RSpec
+  module LogMatcher
+    class Error < StandardError; end
+
+    def log(expected_logs)
+      Matcher.new(expected_logs, @log_file_position)
+    end
+
+    ::RSpec.configure do |config|
+      config.before(:each, type: :feature) do
+        @log_file_position = File.new(Matcher::LOG_PATH).sysseek(0, IO::SEEK_END)
+      end
+
+      config.include ::RSpec::LogMatcher
+    end
+  end
+end

data/lib/rspec/log_matcher.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rspec/log_matcher/version'
+require 'rspec/log_matcher/matcher'

data/lib/rspec/log_matcher/matcher.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RSpec
+  module LogMatcher
+    class Matcher
+      LOG_PATH = ENV.fetch('LOG_PATH', 'log/test.log')
+
+      attr_reader :expected_logs, :initial_log_file_position
+
+      def initialize(expected_logs, initial_log_file_position)
+        @expected_logs = expected_logs
+        @initial_log_file_position = initial_log_file_position || 0
+      end
+
+      def matches?(subject)
+        prepare_matcher(subject)
+
+        case expected_logs
+        when Regexp
+          logs.match?(expected_logs)
+        when Proc
+          logs.include?(expected_logs.call)
+        when String
+          logs.include?(expected_logs)
+        end
+      end
+
+      def failure_message
+        "Expected subject to have logged `#{expected_logs}' in:\n\t#{logs}"
+      end
+
+      def failure_message_when_negated
+        "Expected subject not to have logged `#{expected_logs}' in:\n\t#{logs}"
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      private
+
+      def log_file
+        @log_file ||= File.new(LOG_PATH)
+      end
+
+      def logs
+        @logs ||= log_file.read
+      end
+
+      def prepare_matcher(subject)
+        if subject.is_a?(Proc)
+          log_file.seek(0, IO::SEEK_END)
+          subject.call
+        elsif defined?(Capybara::Session) && subject.is_a?(Capybara::Session)
+          log_file.seek(initial_log_file_position)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/log_matcher/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rspec
+  module LogMatcher
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    VERSION = [MAJOR, MINOR, PATCH].join('.')
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rspec-log_matcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Manuel Ramallo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.91'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.91'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Writing logs is an easy way to store any kind of information for further
+  analysis later on. It's commonly used to store analytics events and then make the
+  logs a source for data engineering tasks. This matcher makes logging testing easier.
+email:
+- juanmanuelramallo@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/rspec-log_matcher.rb
+- lib/rspec/log_matcher.rb
+- lib/rspec/log_matcher/matcher.rb
+- lib/rspec/log_matcher/version.rb
+homepage: https://github.com/juanmanuelramallo/rspec-log_matcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/juanmanuelramallo/rspec-log_matcher
+  source_code_uri: https://github.com/juanmanuelramallo/rspec-log_matcher
+  changelog_uri: https://github.com/juanmanuelramallo/rspec-log_matcher/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: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: RSpec custom matcher to test code that logs information into log files.
+test_files: []