crtu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88c62b01668cad038d2edd7d4d9ac51e986ded33
+  data.tar.gz: 3c1feda010457b8aaf07c3c31f7a3b98193d4610
+SHA512:
+  metadata.gz: 27d90120dc1b5b99268332e1829a4d69eeecc555c2219dc3711c7dbcb13b4c07191b3d91c19ac69c3bf4b6bfcb10a1b2e959949222fd0e1c27cc76c582cfc278
+  data.tar.gz: c3d253b3631a865f7800108b6fb5eed095444e7a5aef027f1b44bed1201fe8bd022d36d4a37ce6bcf47136c272746253bf523dfb68787fe45d02650185907957

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*.idea
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

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 fabio_rodrigues@student-partners.com. 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 crtu.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Th33x1l3
+
+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,21 @@
+CRTU
+
+Cucumber Ruby Test Utilities
+
+Some assorted test utilities for those who do cucumber testing with ruby. 
+
+For now it has:
+
+    Some rake tasks
+    Singleton logger utilitie defined with log4r
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Th33x1l3/crtu. 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. Aside from that feel free to send pull requests with useful code that you want to share.
+
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+import "./lib/tasks/cucumber_tasks.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crtu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crtu"
+  spec.version       = Crtu::VERSION
+  spec.authors       = ["Fábio André Ramos Rodrigues"]
+  spec.email         = ["fabio_rodrigues@student-partners.com"]
+
+  spec.summary       = %q{Cucumber Ruby Test Utilities}
+  spec.description   = %q{Useful Cucumber and ruby test utilities,like loggers, rake tasks, etc...}
+  spec.homepage      = "https://github.com/Th33x1l3/CRTU"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "log4r", "~>1.1.10"
+  spec.add_runtime_dependency "cucumber", '~> 2.3', '> 2.3.0'
+
+end

data/lib/crtu.rb

@@ -0,0 +1,5 @@
+require "crtu/version"
+
+module Crtu
+  # Your code goes here...
+end

data/lib/crtu/utils/logger.rb

@@ -0,0 +1,130 @@
+require 'rubygems'
+require 'singleton'
+require 'fileutils'
+require 'log4r'
+include Log4r
+
+GLOBAL_LOGGER_FOLDER = File.join(Dir.pwd, 'logs')
+GLOBAL_LOGGER_LOG_FILE = File.join(GLOBAL_LOGGER_FOLDER, 'logfile.log')
+
+class GlobalLogger
+  include Singleton
+
+  attr_reader :global_console_logger
+  attr_reader :global_file_logger
+  attr_reader :global_mix_logger
+
+  def initialize
+
+    # Chech if folder exists
+    # that way it creates the logs folder beforehand
+
+    dirname = File.dirname(GLOBAL_LOGGER_FOLDER)
+    unless File.directory?(dirname)
+      FileUtils.mkdir_p(GLOBAL_LOGGER_FOLDER)
+    end
+
+    @global_console_logger= Log4r::Logger.new("GlobalLoggerConsole")
+    @global_file_logger = Log4r::Logger.new("GlobalLoggerFile")
+    @global_mix_logger = Log4r::Logger.new("GlobalLoggerConsoleAndFile")
+
+    pf = PatternFormatter.new(:pattern => "[%l] @ %d : %M")
+
+    so = StdoutOutputter.new("console", :formatter => pf)
+    @global_console_logger.outputters << so
+    @global_console_logger.level = DEBUG
+
+    fo = FileOutputter.new("f1", :filename => GLOBAL_LOGGER_LOG_FILE, :trunc => false, :formatter => pf)
+    @global_file_logger.outputters << fo
+    @global_file_logger.level = DEBUG
+
+    @global_mix_logger.outputters << so
+    @global_mix_logger.outputters << fo
+    @global_mix_logger.level = DEBUG
+
+  end
+end
+
+
+#add instance to kernel so we have global acess to them
+module Kernel
+  # Console only log 
+  def console_logger
+    GlobalLogger.instance.global_console_logger
+  end
+
+  # File only log
+  def file_logger
+    GlobalLogger.instance.global_file_logger
+  end
+
+  # Console and File log
+  def all_logger
+    GlobalLogger.instance.global_mix_logger
+  end
+end
+
+## Local, class wide logger. Should have include LocalLogger added to the class, logger is used
+## In cucumber remenber to add teh Utils module to the world
+## Usage sample:
+## class A
+## include LocalLogger
+## def method
+## mix_logger.debug "Logging to console and File: myHash: #{myHash}"
+## end
+## end
+##
+## It is currently implements three functions:
+## console_logger() - logging to STDOUT
+## file_logger() - logging to FILE
+## mix_logger() - logging to both STDOUT and FILE
+##
+## if LOCAL_LOGGER_LOG_FILE not specified, "/tmp/" + self.class.to_s + "./log" will be used
+##
+
+LOCAL_LOGGER_LOG_FILE = File.join(Dir.pwd, 'logs', 'local_logfile.log')
+module Utils
+  module LocalLogger
+
+    # Class console logger. The messages only go to the stdout
+    # No message is saved to file
+    def console_logger
+      @logger = Log4r::Logger.new("LocalLoggerConsole")
+      pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
+
+      so = StdoutOutputter.new("console", :formatter => pf)
+      @logger.outputters << so
+      @logger.level = DEBUG
+      @logger
+    end
+
+    # Class simple file logger. Message is stored in file, but
+    # it does not appear on stdout
+    def file_logger
+      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? "/tmp/" + self.class.to_s + ".log" : LOCAL_LOGGER_LOG_FILE
+      @logger = Log4r::Logger.new("LocalLoggerFile")
+      pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
+
+      fo = FileOutputter.new("f1", :filename => log_file, :trunc => false, :formatter => pf)
+      @logger.outputters << fo
+      @logger.level = DEBUG
+      @logger
+    end
+
+
+    # Class wide console and file logger. Message appears on console output and it's stored on file
+    def mix_logger
+      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? "/tmp/" + self.class.to_s + ".log" : LOCAL_LOGGER_LOG_FILE
+      @logger = Log4r::Logger.new("LocalLoggerConsoleAndFile")
+      pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
+
+      so = StdoutOutputter.new("console", :formatter => pf)
+      fo = FileOutputter.new("f1", :filename => log_file, :trunc => false, :formatter => pf)
+
+      @logger.outputters << so
+      @logger.outputters << fo
+      @logger.level = DEBUG
+      @logger
+    end
+  end
+end

data/lib/crtu/version.rb

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

data/lib/tasks/cucumber_tasks.rake

@@ -0,0 +1,92 @@
+require 'cucumber/rake/task'
+require 'fileutils'
+
+class BuildFailure < Exception;
+  def initialize(message = nil)
+    message ||= "Build failed"
+    super(message)
+  end
+end;
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "-r features/ --format progress --out reports/progress.out --format html --out reports/report.html --format json --out reports/cucumber.json"
+end
+
+desc "Create log and reports folder in current directory"
+task :create_log_report_folders do
+  log_path = File.join(Dir.pwd, 'logs')
+  report_path = File.join(Dir.pwd,'reports')
+
+  unless File.directory?(log_path)
+    FileUtils.mkdir_p(log_path)
+  end
+
+  unless File.directory?(report_path)
+    FileUtils.mkdir_p(report_path)
+  end
+end
+
+
+task :cleanup do
+  puts '============    Deleting old logs and reports   ==============='
+  puts "PLEASE DON'T USE THIS TASK IN CI SERVER, USE CI OPTIONS INSTEAD"
+  puts '=====  USE THIS ONLY FOR DEVELOPMENT IN YOUR OWN MACHINE  ====='
+
+  log_path = File.join(Dir.pwd, 'logs')
+  report_path = File.join(Dir.pwd,'reports')
+
+  FileUtils.rm_rf(log_path)
+  FileUtils.rm_rf(report_path)
+  Rake::Task['create_log_report_folders'].invoke
+end
+
+
+
+namespace :features do
+  desc "Run finished features"
+  Cucumber::Rake::Task.new(:finished) do |t|
+    t.cucumber_opts = "-r features/ --format progress --out reports/progress.out --format html --out reports/report.html --format json --out reports/cucumber.json --tags ~@wip"
+  end
+
+  desc "Run in-progress features"
+  Cucumber::Rake::Task.new(:in_progress) do |t|
+    t.cucumber_opts = "-r features/ --require formatters/ --format progress --out reports/progress.out --format html --out reports/report.html --format json --out reports/cucumber.json --tags @wip"
+  end
+
+
+  desc "Run features with given tags - OR joing"
+  task :run_with_tags, [:tags] do |t,args|
+    if args[:tags].is_a?(String)
+      tags_line = args[:tags]
+    else
+      tags_line = args[:tags].join(',')
+    end
+    Cucumber::Rake::Task.new(t) do |c|
+      c.cucumber_opts = "-r features/ --format progress --out reports/progress.out --format html --out reports/report.html  --format json --out reports/cucumber.json --tags #{tags_line}"
+    end
+  end
+end
+
+desc "Run complete feature build"
+task :cruise do
+  finished_successful = run_and_check_for_exception("finished")
+  in_progress_successful = run_and_check_for_exception("in_progress")
+
+  unless finished_successful && in_progress_successful
+    puts
+    puts("Finished features had failing steps") unless finished_successful
+    puts("In-progress Scenario/s passed when they should fail or be pending") unless in_progress_successful
+    puts
+    raise BuildFailure
+  end
+end
+
+def run_and_check_for_exception(task_name)
+  puts "*** Running #{task_name} features ***"
+  begin
+    Rake::Task["features:#{task_name}"].invoke
+  rescue Exception => e
+    return false
+  end
+  true
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: crtu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fábio André Ramos Rodrigues
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: Useful Cucumber and ruby test utilities,like loggers, rake tasks, etc...
+email:
+- fabio_rodrigues@student-partners.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crtu.gemspec
+- lib/crtu.rb
+- lib/crtu/utils/logger.rb
+- lib/crtu/version.rb
+- lib/tasks/cucumber_tasks.rake
+homepage: https://github.com/Th33x1l3/CRTU
+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: Cucumber Ruby Test Utilities
+test_files: []