testcube 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4efe39bf13999143ee88fc92aba4315b915fc94
+  data.tar.gz: f9b8b4e2ab3845492326ed4ab0b5fad21b9389c5
+SHA512:
+  metadata.gz: 035f9bfddbda70489f9745b1348a3a3896c493ec113d39860e52edd86a0784fbe97731d3ce368bfd3ddceb668d4b9d608f7a7f8fb5ad219f5976ccc608807869
+  data.tar.gz: 4dd9dbd36fac7873e756401d863468fc219620e742f62449ae661efe5e6a52875d4155308764fb23a84d93e16f1664a35d3db0b6ba038ad2c9fe440168f8a455

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.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 ankur@flexport.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in testcube.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    testcube (0.1.0)
+      httprb
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httprb (0.1.5)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  testcube!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ankur
+
+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,43 @@
+# Testcube
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/testcube`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testcube'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testcube
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/[USERNAME]/testcube. 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 Testcube project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/testcube/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "testcube"
+
+# 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/testcube/adapters/base_adapter.rb

@@ -0,0 +1,34 @@
+module Testcube
+  module Adapters
+    class BaseAdapter
+      attr_accessor :api_key
+
+      def self.bind(api_key)
+        adapter = new
+        adapter.api_key = api_key
+        if api_key
+          adapter.bind
+        else
+          Testcube.logger.warn('No api key specified. Not recording!')
+        end
+        adapter
+      end
+
+      def bind
+        if Testcube::Config::Env.recording_enabled?
+          Testcube.logger.info('Test suite time execution recording enabled.')
+          bind_time_tracker
+          bind_save_report
+        end
+      end
+
+      def bind_time_tracker
+        raise NotImplementedError
+      end
+
+      def bind_save_report
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/testcube/adapters/rspec_adapter.rb

@@ -0,0 +1,38 @@
+require_relative "base_adapter"
+require_relative "../report"
+
+module Testcube
+  module Adapters
+    class RSpecAdapter < BaseAdapter
+      def bind_time_tracker
+        # TODO: we need to filter testcube from rspec backtraces
+        ::RSpec.configure do |config|
+          config.around(:each) do |example|
+            Testcube.tracker.current_test_path = example.metadata[:file_path]
+            Testcube.tracker.current_line_number = example.metadata[:line_number]
+            Testcube.tracker.start_timer
+
+            example.run
+
+            Testcube.tracker.current_exception = example.exception
+            Testcube.tracker.stop_timer
+          end
+
+          config.after(:suite) do
+            Testcube.logger.debug("Total time: #{Testcube.tracker.total_time.round(2)}s")
+            Testcube.logger.debug("Saw #{Testcube.tracker.num_specs} specs")
+          end
+        end
+      end
+
+      def bind_save_report
+        adapter = self
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            Testcube::Report.save(adapter.api_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/testcube/build_env.rb

@@ -0,0 +1,45 @@
+module Testcube
+  class BuildEnv
+    def self.current
+      sha, author, author_email, commit_message = git_show
+      # TODO master fork sha
+      # TODO could also get some of this data from github api
+      {
+        sha: sha,
+        author: author,
+        author_email: author_email,
+        commit_message: commit_message,
+        branch: branch,
+        build_url: build_url,
+      }
+    end
+
+    # TODO: Add support for other CI systems
+    def self.branch
+      ENV['BUILDKITE_BRANCH'] || git('rev-parse --abbrev-ref HEAD')
+    end
+
+    def self.build_url
+      ENV['BUILDKITE_BUILD_URL']
+    end
+
+    def self.git_show
+      out = git('show --format=short --no-patch')
+      return [nil, nil, nil, nil] if !out
+
+      # TODO: dont rescue nil
+      sha = out.match(/commit ([0-9a-f]+)\n/)[1] rescue nil
+      author = out.match(/Author: (.*?) <(.*)>\n/)[1] rescue nil
+      author_email = out.match(/Author: (.*?) <(.*)>\n/)[2] rescue nil
+      message = out.lines[2..(out.lines.length)].find { |l| l.strip.length > 0 }.strip rescue nil
+
+      return [sha, author, author_email, message]
+    end
+
+    def self.git(cmd)
+      `git #{cmd}`.strip
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+end

data/lib/testcube/config/env.rb

@@ -0,0 +1,20 @@
+module Testcube
+  module Config
+    class Env
+      class << self
+        # TODO Read from ENV vars here
+        def recording_enabled?
+          true
+        end
+
+        def log_level
+          {
+            "debug" => ::Logger::DEBUG,
+            "info"  => ::Logger::INFO,
+            "warn"  => ::Logger::WARN,
+          }[ENV['TESTCUBE_LOG_LEVEL']] || ::Logger::INFO
+        end
+      end
+    end
+  end
+end

data/lib/testcube/report.rb

@@ -0,0 +1,48 @@
+require "json"
+require "http"
+require_relative "build_env"
+
+module Testcube
+  class Report
+    UPLOAD_START_URL = "https://us-central1-testcube.cloudfunctions.net/startUpload"
+    def self.save(api_key)
+      test_files = Testcube.tracker.test_files_with_time
+
+      if test_files.empty?
+        Testcube.logger.warn("No test files were executed")
+      end
+
+      upload_results(test_files, Testcube::BuildEnv.current, api_key)
+    end
+
+    def self.upload_results(test_files, build_env, api_key)
+      content = JSON.generate({ results: test_files, build_env: build_env })
+
+      # get upload url
+      start = Time.now
+      res = HTTP.post(UPLOAD_START_URL, headers: { 'X-TESTCUBE-API-KEY' => api_key })
+      Testcube.logger.debug("uploadStart: #{Time.now - start}")
+
+      upload_url = nil
+      if res.status.success?
+        upload_url = JSON.parse(res.body.to_s)['uploadURL']
+      else
+        Testcube.logger.warn("Failed to upload to testcube!")
+        return
+      end
+
+      start = Time.now
+      res = HTTP.put(upload_url, body: content)
+      Testcube.logger.debug("resultsUpload: #{Time.now - start}")
+
+      if res.status.success?
+        Testcube.logger.info("Successfully uploaded results!")
+      else
+        Testcube.logger.warn("Failed to upload to testcube!")
+        return
+      end
+
+      Testcube.logger.info("#{res.status}, #{res.code}, #{res.body}")
+    end
+  end
+end

data/lib/testcube/tracker.rb

@@ -0,0 +1,68 @@
+require 'singleton'
+
+module Testcube
+  class Tracker
+    include Singleton
+
+    attr_reader :test_files_with_time
+    attr_writer :current_test_path, :current_line_number, :current_exception
+
+    def initialize
+      set_defaults
+    end
+
+    def start_timer
+      @start_time = now_without_mock_time.to_f
+    end
+
+    def stop_timer
+      execution_time = @start_time ? now_without_mock_time.to_f - @start_time : 0.0
+      @test_files_with_time.push({
+        test_file: current_test_path,
+        line_number: current_line_number,
+        status: current_exception ? :fail : :pass,
+        # TODO: we could have a better way to filter the backtrace
+        backtrace: current_exception ? current_exception.backtrace.select { |s| s !~ /gems\/.*(rspec|bin)/ } : nil,
+        execution_time: execution_time
+      })
+    end
+
+    def current_test_path
+      raise("current_test_path needs to be set") unless @current_test_path
+      @current_test_path.sub(/^\.\//, '')
+    end
+
+    def current_line_number
+      raise("current_line_number needs to be set") unless @current_line_number
+      @current_line_number
+    end
+
+    def current_exception
+      # can be nil
+      @current_exception
+    end
+
+    def total_time
+      test_files_with_time.map { |res| res[:execution_time] }.sum
+    end
+
+    def num_specs
+      test_files_with_time.length
+    end
+
+    private
+
+    def set_defaults
+      @global_time = 0
+      @test_files_with_time = []
+    end
+
+    def now_without_mock_time
+      if defined?(Timecop)
+        Time.now_without_mock_time
+      else
+        Time.now
+      end
+    end
+  end
+end

data/lib/testcube/version.rb

@@ -0,0 +1,3 @@
+module Testcube
+  VERSION = "0.1.0"
+end

data/lib/testcube.rb

@@ -0,0 +1,25 @@
+require "logger"
+require "testcube/version"
+require_relative "testcube/adapters/rspec_adapter"
+require_relative "testcube/config/env"
+require_relative "testcube/tracker"
+
+module Testcube
+  class << self
+    def logger
+      unless @logger
+        default_logger = ::Logger.new(STDOUT)
+        default_logger.level = Testcube::Config::Env.log_level
+        default_logger.formatter = proc do |severity, datetime, progname, msg|
+          "[Testcube] #{severity} #{datetime.strftime("%H:%M:%S")}: #{msg}\n"
+        end
+        @logger = default_logger
+      end
+      @logger
+    end
+
+    def tracker
+      Testcube::Tracker.instance
+    end
+  end
+end

data/testcube.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "testcube/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "testcube"
+  spec.version       = Testcube::VERSION
+  spec.authors       = ["Ankur"]
+  spec.email         = ["ankurdahiya90@gmail.com"]
+
+  # TODO: Update these
+  spec.summary       = "summary"
+  spec.description   = "description"
+  spec.homepage      = "https://testcube.io"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+    #raise "RubyGems 2.0 or newer is required to protect against " \
+      #"public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: testcube
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ankur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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: '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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: description
+email:
+- ankurdahiya90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testcube.rb
+- lib/testcube/adapters/base_adapter.rb
+- lib/testcube/adapters/rspec_adapter.rb
+- lib/testcube/build_env.rb
+- lib/testcube/config/env.rb
+- lib/testcube/report.rb
+- lib/testcube/tracker.rb
+- lib/testcube/version.rb
+- testcube.gemspec
+homepage: https://testcube.io
+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.8
+signing_key: 
+specification_version: 4
+summary: summary
+test_files: []