airborne_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 341027d5bc0c0b14f5909a55dd9ace77581024d6
+  data.tar.gz: a770921562e20a30f7872d40e83fd3e9fd61f352
+SHA512:
+  metadata.gz: 8133f68adb5098ca288636bfa374a2dd477753c5e19c64e516766125e680485b39bd41733e47419cfef9de770995ed3b3540b9b51cb56627bcb7a57d4661e8cc
+  data.tar.gz: 4b9ee896cb80975d0183d6f917955188e1eb0b16671a65be2ff9c16e28a9be14543dc6c127502381e146b7746cca5a4633c0fc97d0e7eb142aa61ffe14949b3a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+report.html
+report.json
+.byebug_history
+storage.json

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at d.efimov@fun-box.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in airborne_report.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Efimov
+
+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,56 @@
+# AirborneReport
+
+Generate reports on tests with the [airborne](https://rubygems.org/gems/airborne) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'airborne_report'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install airborne_report
+    
+## Usage
+
+```
+# spec/spec_helper.rb
+require 'airborne_report'
+```
+
+```
+bundle exec rspec --format AirborneReport::RspecJsonFormatter
+```
+
+or 
+
+```
+bundle exec rspec --format AirborneReport::RspecHtmlFormatter
+```
+
+After that you can find the report in `report.json` or `report.html`.
+
+## 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/funbox/airborne_report. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/airborne_report.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'airborne_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'airborne_report'
+  spec.version       = AirborneReport::VERSION
+  spec.authors       = ['Dmitry Efimov']
+  spec.email         = ['d.efimov@fun-box.ru']
+
+  spec.summary       = 'Generate reports on Airborne tests.'
+  spec.description   =
+    'This gem gives you RSpec formatters which let you generate HTML and JSON reports ' \
+    'if you use the airborne gem for your integration tests.'
+
+  spec.homepage      = 'https://github.com/funbox/airborne_report'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'airborne'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'haml'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'airborne_report'
+
+# 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

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/airborne_report.rb

@@ -0,0 +1,50 @@
+require 'airborne_report/version'
+require 'airborne_report/message'
+
+module AirborneReport
+end
+
+module Airborne
+  module RestClientRequester
+    alias origin_make_request make_request
+
+    def make_request(*args)
+      response = origin_make_request(*args)
+      save!(args, response)
+      response
+    rescue SocketError => error
+      wasted_save(args, response)
+      raise error
+    end
+
+    private
+
+    def save!(args, response)
+      if response.is_a?(RestClient::Response)
+        full_save(response)
+      else
+        wasted_save(args, response)
+      end
+    end
+
+    def full_save(response)
+      request = response.request
+      AirborneReport::JsonFile.push(
+        location,
+        AirborneReport::Message.full(request, response).to_hash
+      )
+    end
+
+    def wasted_save(args, response)
+      url = get_url(args[1])
+      AirborneReport::JsonFile.push(
+        location,
+        AirborneReport::Message.wasted(args, response, url).to_hash
+      )
+    end
+
+    def location
+      inspect.to_s.split('(').last.split(')').first
+    end
+  end
+end

data/lib/airborne_report/json_file.rb

@@ -0,0 +1,25 @@
+require 'multi_json'
+
+module AirborneReport
+  class JsonFile
+    NAME = 'storage.json'.freeze
+
+    def self.save(json)
+      File.open(NAME, 'w') do |file|
+        file.write(MultiJson.dump(json))
+      end
+    end
+
+    def self.push(key, value)
+      save('tests' => tests.merge(key => value))
+    end
+
+    def self.tests
+      MultiJson.load(File.read(NAME))['tests']
+    end
+
+    def self.destroy
+      File.delete(NAME)
+    end
+  end
+end

data/lib/airborne_report/message.rb

@@ -0,0 +1,52 @@
+require 'multi_json'
+require 'airborne_report/json_file'
+
+module AirborneReport
+  class Message
+    def initialize(message)
+      @message = message
+    end
+
+    def self.full(request, response)
+      new(
+        'time' => Time.now,
+        'request' => {
+          'method' => request.method,
+          'url' => request.url,
+          'headers' => request.headers,
+          'body' => request.args
+        },
+        'response' => {
+          'headers' => response.headers,
+          'body' => MultiJson.load(response)
+        }
+      )
+    end
+
+    def self.wasted(args, response, url)
+      new(
+        'time' => Time.now,
+        'request' => {
+          'method' => args[0],
+          'url' => url,
+          'headers' => args[2][:headers],
+          'body' => args[2][:body]
+        },
+        'response' => {
+          'body' => response
+        }
+      )
+    end
+
+    def self.extra(example)
+      new(
+        'full_description' => example.full_description,
+        'status' => example.execution_result.status.to_s
+      )
+    end
+
+    def to_hash
+      @message
+    end
+  end
+end

data/lib/airborne_report/report.rb

@@ -0,0 +1,51 @@
+module AirborneReport
+  class Report
+    def initialize(before_json, notification)
+      after_json = {}
+      statuses = {
+        'all' => 0,
+        'passed' => 0,
+        'failed' => 0,
+        'pending' => 0
+      }
+
+      notification.examples.map do |example|
+        location = example.metadata[:location]
+        after_json[location] = craft_example(before_json, location, example)
+        statuses = increment_statuses(statuses, example)
+      end
+
+      @json = {
+        'statuses' => statuses,
+        'tests' => after_json
+      }
+    end
+
+    def self.blank
+      {
+        'tests' => {}
+      }
+    end
+
+    def to_hash
+      @json
+    end
+
+    private
+
+    def craft_example(before_json, location, example)
+      if before_json[location]
+        Message.extra(example).to_hash.merge(before_json[location])
+      else
+        Message.extra(example).to_hash
+      end
+    end
+
+    def increment_statuses(old_statuses, example)
+      new_statuses = old_statuses
+      new_statuses['all'] += 1
+      new_statuses[example.execution_result.status.to_s] += 1
+      new_statuses
+    end
+  end
+end

data/lib/airborne_report/rspec_html_formatter.rb

@@ -0,0 +1,37 @@
+require 'rspec/core/formatters/base_formatter'
+require 'haml'
+require 'airborne_report/json_file'
+require 'airborne_report/report'
+
+module AirborneReport
+  class RspecHtmlFormatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self, :start, :stop
+
+    def start(_notification)
+      AirborneReport::JsonFile.save(Report.blank)
+    end
+
+    def stop(notification)
+      tests = AirborneReport::JsonFile.tests
+      AirborneReport::JsonFile.destroy
+
+      report = Report.new(tests, notification).to_hash
+      craft_html(report)
+    end
+
+    def craft_html(report)
+      contents = File.read(File.expand_path('../view/report.html.haml', __FILE__))
+      html = "<style>\n#{File.read(File.expand_path('../view/style.css', __FILE__))}\n</style>\n"
+      i = 0
+      html += Haml::Engine.new(contents).render(
+        Object.new,
+        :@tests => report['tests'],
+        :@statuses => report['statuses'],
+        :@i => i
+      )
+      File.open('report.html', 'w') do |file|
+        file.write(html)
+      end
+    end
+  end
+end

data/lib/airborne_report/rspec_json_formatter.rb

@@ -0,0 +1,28 @@
+require 'rspec/core/formatters/base_formatter'
+require 'multi_json'
+require 'airborne_report/json_file'
+require 'airborne_report/report'
+
+module AirborneReport
+  class RspecJsonFormatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self, :start, :stop
+
+    def start(_notification)
+      AirborneReport::JsonFile.save(Report.blank)
+    end
+
+    def stop(notification)
+      tests = AirborneReport::JsonFile.tests
+      AirborneReport::JsonFile.destroy
+
+      report = Report.new(tests, notification).to_hash
+      craft_json(report)
+    end
+
+    def craft_json(report)
+      File.open('report.json', 'w') do |file|
+        file.write(MultiJson.dump(report))
+      end
+    end
+  end
+end

data/lib/airborne_report/version.rb

@@ -0,0 +1,3 @@
+module AirborneReport
+  VERSION = '0.1.0'.freeze
+end

data/lib/airborne_report/view/report.html.haml

@@ -0,0 +1,83 @@
+!!! 5
+%html
+  %head
+    %title= Time.now
+    %meta{charset: "utf-8"}
+  %body
+    %div
+      %b
+        all:
+        = @statuses["all"]
+      %b{class: "passed"}
+        passed:
+        = @statuses["passed"]
+      %b{class: "failed"}
+        failed:
+        = @statuses["failed"]
+      %b{class: "pending"}
+        pending:
+        = @statuses["pending"]
+    - @tests.each do |example|
+      %details
+        %summary{class: "collapse #{example.last['status']}"}
+          = example.last['full_description']
+        %div
+          %div{class: 'section'}
+          - if example.last['request'] && example.last['response']['body']
+            %div
+              %b path:
+              = example.first
+            %div
+              %b time:
+              = example.last['time']
+            %div{class: 'section'}
+              %div
+                %b request.method:
+                = example.last['request']['method']
+              %div
+                %b request.url:
+                = example.last['request']['url']
+              %div
+                %b request.headers:
+                = example.last['request']['headers']
+              %div
+                %b request.body:
+                %xmp
+                  = example.last['request']['body']
+            %div{class: 'section'}
+              %div
+                %b response.headers:
+                = example.last['response']['headers']
+              %div
+                %b response.body:
+                %xmp
+                  = example.last['response']['body']
+          - elsif example.last['request']
+            %div
+              %b path:
+              = example.first
+            %div{class: 'section'}
+              %div
+                %b request.method:
+                = example.last['request']['method']
+              %div
+                %b request.url:
+                = example.last['request']['url']
+              %div
+                %b request.headers:
+                = example.last['request']['headers']
+              %div
+                %b request.body:
+                = example.last['request']['body']
+            %div{class: 'section'}
+              %div
+                Request failed
+          - elsif example.last['status'] == 'pending'
+            %div
+              %b path:
+              = example.first
+          - else
+            %div
+              %b path:
+              = example.first
+            Test failed

data/lib/airborne_report/view/style.css

@@ -0,0 +1,41 @@
+summary {
+    margin: 10px;
+}
+
+summary:hover {
+    background: #e1e1e1;
+}
+
+.passed {
+    color: green;
+}
+
+.failed {
+    color: red;
+}
+
+.pending {
+    color: orange;
+}
+
+.collapse {
+    cursor: pointer;
+    display: block;
+    background: white;
+}
+
+.collapse + input {
+    display: none; /* hide the checkboxes */
+}
+
+.collapse + input + div {
+    display: none;
+}
+
+.collapse + input:checked + div {
+    display: block;
+}
+
+.section {
+    padding-top: 10px;
+}

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: airborne_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Efimov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airborne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem gives you RSpec formatters which let you generate HTML and JSON
+  reports if you use the airborne gem for your integration tests.
+email:
+- d.efimov@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- airborne_report.gemspec
+- bin/console
+- bin/setup
+- lib/airborne_report.rb
+- lib/airborne_report/json_file.rb
+- lib/airborne_report/message.rb
+- lib/airborne_report/report.rb
+- lib/airborne_report/rspec_html_formatter.rb
+- lib/airborne_report/rspec_json_formatter.rb
+- lib/airborne_report/version.rb
+- lib/airborne_report/view/report.html.haml
+- lib/airborne_report/view/style.css
+homepage: https://github.com/funbox/airborne_report
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generate reports on Airborne tests.
+test_files: []