report_factory-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99f8061be2d4748bb726f5c3d82fc5227a1114b1
+  data.tar.gz: a11ae46c7e7e1b06261860a8a6bbc4da51cd4856
+SHA512:
+  metadata.gz: 6493ed54f04c27eddfb9e45dc73142f6113dff8562c5f18b63f3e4631b08a92caae280ed8326cf2f648cf40edd806c677968b03ba64e135cde7e0b71688417e3
+  data.tar.gz: afad6732a00c255d919c7c60611d32b790eff327922cd1b510a8487d07a8d13d66b512cc8652fed581cfca396f914f90f9230245a0453d0804da29bd21d80fd6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+
+/tags
+/*.gem
+*.swp
+*.vim
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper --format doc
+ --format ReportFactory::Rspec::Formatter

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*_spec.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+report_factory-rspec

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contactigorstar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in report_factory-rspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    report_factory-rspec (0.1.0)
+      rspec (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  report_factory-rspec!
+  rubocop (~> 0.51.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 IgorS
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 igor-starostenko
+
+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,64 @@
+# ReportFactory::Rspec
+
+*ReportFactory* helps you save each of your test runs so that they are always available for reports and analytics.
+It consists of three parts:
+1. A [rails server](https://github.com/igor-starostenko/report_factory) that provides an interface via JSON API and saves your test runs in a DB;
+2. A web application which gives you an easy way to configure your test projects and reports (Currently in development);
+3. And a test formatter that automatically sends reports to the server after each test run. This repo is the formatter for RSpec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'report_factory-rspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install report_factory-rspec
+
+## Usage
+
+Before you start using this formatter, make sure you have the [ReportFactory](https://github.com/igor-starostenko/report_factory) server deployed and running.
+
+To setup this formatter to work with your RSpec tests, add this to your `spec_helper.rb` file:
+
+```ruby
+require 'report_factory-rspec'
+```
+
+and configure:
+
+```ruby
+ReportFactory::RSpec.configure do |config|
+  config.url = "The url of the ReportFactory server. It's 'http://0.0.0.0:3000' if you're running locally"
+  config.project_name = "The name of the project that you are testing. Needs to be previously created in ReportFactory"
+  config.auth_token = "Your user X_API_KEY. Can be found in ReportFactory in your user information"
+end
+```
+
+Then you can just simply run rspec with `--format ReportFactory::RSpec::Formatter` and your reports will be available on the server after each test run.
+You can add that line to your `.rspec` file if you want it to be the default behavior.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/igor-starostenko/report_factory-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 ReportFactory::Rspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/igor-starostenko/report_factory-rspec/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'report_factory/rspec'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/report_factory/rspec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'report_factory/rspec/configuration'
+require 'report_factory/rspec/version'
+
+module ReportFactory
+  # Top level namespace module
+  module Rspec
+    extend Configuration
+    # TODO: Add method missing
+  end
+end
+
+require 'report_factory/rspec/formatter'

data/lib/report_factory/rspec/api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+module ReportFactory
+  module Rspec
+    # An RSpec formatter that formats json from the test run
+    class API
+      def self.send_report(report_hash)
+        uri = create_report_url
+        request = Net::HTTP::Post.new(uri.request_uri, format_headers)
+        request.body = format_payload(report_hash).to_json
+        net_http = Net::HTTP.new(uri.host, uri.port)
+        net_http.use_ssl = true if uri.scheme == 'https'
+        net_http.request(request)
+      end
+
+      def self.format_headers
+        {
+          'Content-Type': 'application/json',
+          'X-API-KEY' => x_api_key
+        }
+      end
+
+      def self.format_payload(report_hash)
+        {
+          data: {
+            type: 'rspec_report',
+            attributes: report_hash
+          }
+        }
+      end
+
+      def self.x_api_key
+        ReportFactory::Rspec.auth_token
+      end
+
+      def self.base_url
+        ReportFactory::Rspec.url
+      end
+
+      def self.project_name
+        ReportFactory::Rspec.project_name
+      end
+
+      def self.create_report_url
+        URI.parse("#{base_url}/api/v1/projects/#{project_name}/reports/rspec")
+      end
+    end
+  end
+end

data/lib/report_factory/rspec/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ReportFactory
+  module Rspec
+    # Defines all configurable attributes of ReportFactory::RSpec
+    module Configuration
+      VALID_CONFIG_KEYS = %i[url project_name auth_token].freeze
+
+      DEFAULT_URL = 'http://0.0.0.0:3000'
+
+      DEFAULT_PROJECT_NAME = nil
+
+      DEFAULT_AUTH_TOKEN = nil
+
+      VALID_CONFIG_KEYS.each { |key| attr_accessor key }
+
+      # Make sure the default values are set when the module is 'extended'
+      def self.extended(base)
+        base.reset
+      end
+
+      def configure
+        yield self
+      end
+
+      def reset
+        VALID_CONFIG_KEYS.each do |key|
+          constant_name = "DEFAULT_#{key}".upcase
+          send("#{key}=", self::Configuration.const_get(constant_name))
+        end
+      end
+    end
+  end
+end

data/lib/report_factory/rspec/formatter.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'report_factory/rspec/api'
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+
+module ReportFactory
+  module Rspec
+    # An RSpec formatter that formats json from the test run
+    class Formatter < RSpec::Core::Formatters::BaseFormatter
+      RSpec::Core::Formatters.register self, :message, :dump_summary,
+                                       :dump_profile, :stop, :seed, :close
+
+      attr_reader :output_hash
+
+      def initialize(output)
+        super
+        @output_hash = {
+          version: RSpec::Core::Version::STRING
+        }
+      end
+
+      def message(notification)
+        (@output_hash[:messages] ||= []) << notification.message
+      end
+
+      def dump_summary(summary)
+        errors_outside_count = summary.errors_outside_of_examples_count
+        @output_hash[:summary] = {
+          duration: summary.duration,
+          example_count: summary.example_count,
+          failure_count: summary.failure_count,
+          pending_count: summary.pending_count,
+          errors_outside_of_examples_count: errors_outside_count
+        }
+        @output_hash[:summary_line] = summary.totals_line
+      end
+
+      def stop(notification)
+        @output_hash[:examples] = notification.examples.map do |example|
+          format_example(example).tap do |hash|
+            hash[:exception] = format_exception(example)
+          end
+        end
+      end
+
+      def seed(notification)
+        return unless notification.seed_used?
+        @output_hash[:seed] = notification.seed
+      end
+
+      def close(_notification)
+        return if @output_hash[:examples].empty?
+        print_result(ReportFactory::Rspec::API.send_report(@output_hash))
+      end
+
+      def dump_profile(profile)
+        @output_hash[:profile] = {}
+        dump_profile_slowest_examples(profile)
+        dump_profile_slowest_example_groups(profile)
+      end
+
+      # @api private
+      def dump_profile_slowest_examples(profile)
+        @output_hash[:profile] = {}
+        @output_hash[:profile][:examples] = format_profile_examples(profile)
+        @output_hash[:profile][:slowest] = profile.slow_duration
+        @output_hash[:profile][:total] = profile.duration
+      end
+
+      # @api private
+      def dump_profile_slowest_example_groups(profile)
+        @output_hash[:profile] ||= {}
+        @output_hash[:profile][:groups] = format_profile_groups(profile)
+      end
+
+      private
+
+      def print_result(response)
+        return print_success if response.code == '201'
+        print_error(response)
+      end
+
+      def print_success
+        output.write "Report was successfullty submitted to ReportFactory\n"
+      end
+
+      def print_error(response)
+        output.write 'Unfortunately the test report could not be submitted'\
+                     " to ReportFactory. #{response.code}: #{response.msg}\n"
+      end
+
+      def format_example(example)
+        {
+          id: example.id,
+          description: example.description,
+          full_description: example.full_description,
+          status: example.execution_result.status.to_s,
+          file_path: example.metadata[:file_path],
+          line_number: example.metadata[:line_number],
+          run_time: example.execution_result.run_time,
+          pending_message: example.execution_result.pending_message
+        }
+      end
+
+      def format_exception(example)
+        exception = example.exception
+        return unless exception
+        {
+          class: exception.class.name,
+          message: exception.message,
+          backtrace: exception.backtrace
+        }
+      end
+
+      def format_profile_examples(profile)
+        profile.slowest_examples.map do |example|
+          format_example(example).tap do |hash|
+            hash[:run_time] = example.execution_result.run_time
+          end
+        end
+      end
+
+      def format_profile_groups(profile)
+        profile.slowest_groups.map { |loc, hash| hash.update(location: loc) }
+      end
+    end
+  end
+end

data/lib/report_factory/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ReportFactory
+  module Rspec
+    VERSION = '0.1.0'
+  end
+end

data/report_factory-rspec.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'report_factory/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'report_factory-rspec'
+  spec.version       = ReportFactory::Rspec::VERSION
+  spec.authors       = ['Igor Starostenko']
+  spec.email         = ['contactigorstar@gmail.com']
+
+  spec.summary       = "report_factory-rspec_#{ReportFactory::Rspec::VERSION}"
+  spec.description   = 'RSpec adapter for report_factory'
+  spec.homepage      = 'https://github.com/igor-starostenko/report_factory-rspec'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rspec', '~> 3.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rubocop', '~> 0.51.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: report_factory-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Starostenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+description: RSpec adapter for report_factory
+email:
+- contactigorstar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/report_factory/rspec.rb
+- lib/report_factory/rspec/api.rb
+- lib/report_factory/rspec/configuration.rb
+- lib/report_factory/rspec/formatter.rb
+- lib/report_factory/rspec/version.rb
+- report_factory-rspec.gemspec
+homepage: https://github.com/igor-starostenko/report_factory-rspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: report_factory-rspec_0.1.0
+test_files: []