strut 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c99d8da5a37d0df59242034dbd19880a55f3d0
+  data.tar.gz: 78be5c9a57ea02b04c689739803a3c235e322352
+SHA512:
+  metadata.gz: e0ec403b21ec73ac3a5a0fc74dfbaa5b04fd67c2170c689c28b101ef4f54cac9e8f2416f5658a380088c8d76ba9a2374b97f3741e17a0650c381141d9a161ac7
+  data.tar.gz: 88f3dfda24b2ce97748dc248e277ab3f0fa24f6efafcd239751426d95d058756d397c7897f20b094b7bddd4e086efd174c3677d6e88187cca1fd55f62619a9ae

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,7 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dan Cutting
+
+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,80 @@
+# Strut
+
+[![Build Status](https://travis-ci.org/dcutting/strut.svg?branch=master)](https://travis-ci.org/dcutting/strut)
+[![Coverage Status](https://coveralls.io/repos/dcutting/strut/badge.svg?branch=master&service=github)](https://coveralls.io/github/dcutting/strut?branch=master)
+[![Code Climate](https://codeclimate.com/github/dcutting/strut/badges/gpa.svg)](https://codeclimate.com/github/dcutting/strut)
+
+Acceptance testing with [Swagger](http://swagger.io).
+
+Rather than testing your web service through the API (and therefore requiring your whole stack to be up and running with sample data), Strut uses [Slim](http://www.fitnesse.org/FitNesse.UserGuide.WritingAcceptanceTests.SliM.SlimProtocol) and fixture code. This lets you mock out databases and other external systems, while still covering the major parts of your web service API.
+
+## Why?
+
+* Want to specify our web service APIs in Swagger
+    - Because it’s pretty
+    - Because it’s concise
+    - Because it has tools that help you transform it into docs, etc.
+* Want to write automated acceptance tests for our web service APIs
+    - Because we don’t want to manually test it for releases
+    - Because we want to be confident we don’t break it accidentally
+* Don’t want to duplicate the API in the Swagger spec and the test suite
+    - Because the Swagger spec will drift out of sync
+    - Because we’ll need to maintain two different ways of saying similar things
+* Therefore, Strut!
+
+## Installation
+
+Strut is a command-line tool installed via [RubyGems](https://rubygems.org):
+
+    $ gem install strut
+
+Then run it from any directory containing a .strut.yml configuration file:
+
+    $ strut
+
+## .strut.yml configuration file
+
+You need a .strut.yml configuration file in the directory where you run strut (or you can specify a path to one as the only argument to strut). That file should look like this:
+
+    swagger:
+      my_service.yaml
+    runner:
+      Runner.exe -a "..\MyService.Specs\bin\Debug\MyService.Specs.dll.config" -r fitSharp.Slim.Service.Runner,Slim/fitsharp.dll MyService.Specs/bin/Debug/MyService.Specs.dll 9011
+    host:
+      localhost
+    port:
+      9011
+    max_attempts:
+      3
+    namespace:
+      Specs
+    output:
+      pretty
+
+The `runner` property is a command that runs the Slim server and attaches to your system under test. Strut will automatically run this for you, and kill it when the tests complete. This is an optional parameter. If omitted, Strut will still attempt to connect to the provided host and port, but you will need to manually ensure the Slim server is running.
+
+You can have "pretty" output (similar to default Cucumber output), or "junit" XML output.
+
+## 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).
+
+### Windows
+
+* Install Ruby using [RubyInstaller](http://rubyinstaller.org)
+* Install [gitbash](https://git-scm.com/download/win)
+* gem install bundler
+* git clone git@github.com:dcutting/strut.git
+* cd strut
+* bin/setup
+* bundle exec ruby exe/strut .strut.yml
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dcutting/strut. 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,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 "strut"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/strut

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'strut'
+
+Strut.run(ARGV)

data/lib/strut.rb

@@ -0,0 +1,60 @@
+require "strut/config"
+require "strut/parser"
+require "strut/report_builder"
+require "strut/report_junit_formatter"
+require "strut/report_pretty_formatter"
+require "strut/slim_client"
+require "strut/version"
+
+module Strut
+  def self.run(args)
+    Strut.new.run(args)
+  end
+
+  class Strut
+    def run(args)
+      config_file = args.shift || ".strut.yml"
+      config = read_config(config_file)
+
+      yaml = File.read(config.swagger)
+      document = Parser.new(config.namespace).parse(yaml)
+
+      responses = get_responses(config, document)
+      exit if responses.nil?
+
+      report = ReportBuilder.new.build(responses, document)
+      formatter = make_formatter(config, yaml)
+      output = formatter.format(report)
+      puts output
+    end
+
+    def read_config(config_file)
+      begin
+        return Config.new(config_file)
+      rescue => e
+        puts e
+        exit
+      end
+    end
+
+    def get_responses(config, document)
+      pid = config.runner ? spawn(config.runner) : nil
+      begin
+        client = SlimClient.new(config.host, config.port, config.max_attempts)
+        return client.responses_for_commands(document.commands)
+      rescue => e
+        puts e
+      ensure
+        Process.kill("KILL", pid) unless pid.nil?
+      end
+    end
+
+    def make_formatter(config, yaml)
+      if config.output == :junit
+        return ReportJUnitFormatter.new
+      else
+        return ReportPrettyFormatter.new(yaml)
+      end
+    end
+  end
+end

data/lib/strut/annotation.rb

@@ -0,0 +1,7 @@
+module Strut
+  ANNOTATION_OK = :ok
+  ANNOTATION_FAIL = :fail
+  ANNOTATION_EXCEPTION = :exception
+
+  Annotation = Struct.new(:type, :message)
+end

data/lib/strut/config.rb

@@ -0,0 +1,60 @@
+require "pathname"
+require "strut/extensions"
+
+module Strut
+  class Config
+    attr_reader :swagger, :runner, :host, :port, :max_attempts, :namespace, :output
+
+    def initialize(config_file)
+      path = File.dirname(config_file)
+      read_and_store(config_file, path)
+    end
+
+    def read_and_store(config_file, path)
+      yaml = File.read(config_file)
+      parsed_yaml = Psych::parse_yaml(yaml)
+      store_values(parsed_yaml, path)
+    end
+
+    def store_values(yaml, config_path)
+      @swagger = swagger_path(yaml, config_path)
+      @runner = extract_optional_value(yaml, "runner")
+      @host = extract_value(yaml, "host")
+      @port = extract_int_value(yaml, "port")
+      @max_attempts = extract_int_value(yaml, "max_attempts")
+      @namespace = extract_value(yaml, "namespace")
+      @output = extract_enum_value(yaml, "output", [:junit, :pretty])
+    end
+
+    def swagger_path(yaml, config_path)
+      swagger_path = Pathname.new(extract_value(yaml, "swagger"))
+      unless swagger_path.absolute?
+        swagger_path = Pathname.new(config_path) + swagger_path
+      end
+      swagger_path.to_s
+    end
+
+    def extract_optional_value(yaml, name)
+      extract_value(yaml, name, true)
+    end
+
+    def extract_value(yaml, name, optional = false)
+      value = yaml[name]
+      value = value["value"] unless value.nil?
+      throw "No '#{name}' specified." if value.nil? and !optional
+      value
+    end
+
+    def extract_int_value(yaml, name)
+      value = extract_value(yaml, name).to_i
+      throw "'#{name}' must be a number > 0." unless value > 0
+      value
+    end
+
+    def extract_enum_value(yaml, name, enums)
+      value = extract_value(yaml, name).to_sym
+      throw "'#{name}' must be one of #{enums}." unless enums.include?(value)
+      value
+    end
+  end
+end

data/lib/strut/document.rb

@@ -0,0 +1,14 @@
+module Strut
+  class Document
+    attr_reader :commands
+
+    def initialize(commands)
+      @commands = commands
+    end
+
+    def metadata_for_command_id(id)
+      command = @commands.find { |c| c.id == id }
+      command ? command.metadata : nil
+    end
+  end
+end

data/lib/strut/document_builder.rb

@@ -0,0 +1,17 @@
+require "strut/document"
+
+module Strut
+  class DocumentBuilder
+    def initialize
+      @commands = []
+    end
+
+    def append_command(command)
+      @commands << command
+    end
+
+    def document
+      Document.new(@commands)
+    end
+  end
+end

data/lib/strut/extensions.rb

@@ -0,0 +1,81 @@
+require "psych"
+require "psych/nodes"
+require "psych/tree_builder"
+
+# Adapted from:
+# http://stackoverflow.com/questions/29462856/loading-yaml-with-line-number-for-each-key
+
+module Psych
+  def self.parse_yaml(yaml)
+    handler = LineNumberHandler.new
+    parser =  Psych::Parser.new(handler)
+    handler.parser = parser
+    parser.parse(yaml)
+    handler.root.to_ruby.first
+  end
+end
+
+# Psych's first step is to parse the Yaml into an AST of Node objects
+# so we open the Node class and add a way to track the line.
+class Psych::Nodes::Node
+  attr_accessor :line
+end
+
+# We need to provide a handler that will add the line to the node
+# as it is parsed. TreeBuilder is the "usual" handler, that
+# creates the AST.
+class LineNumberHandler < Psych::TreeBuilder
+
+  # The handler needs access to the parser in order to call mark
+  attr_accessor :parser
+
+  # We are only interested in scalars, so here we override
+  # the method so that it calls mark and adds the line info
+  # to the node.
+  def scalar value, anchor, tag, plain, quoted, style
+    mark = parser.mark
+    s = super
+    s.line = mark.line
+    s
+  end
+
+  def start_mapping anchor, tag, implicit, style
+    mark = parser.mark
+    s = super
+    s.line = mark.line
+    s
+  end
+
+  def start_sequence anchor, tag, implicit, style
+    mark = parser.mark
+    s = super
+    s.line = mark.line
+    s
+  end
+end
+
+# The next step is to convert the AST to a Ruby object.
+# Psych does this using the visitor pattern with the ToRuby
+# visitor. Here we patch ToRuby rather than inherit from it
+# as it makes the last step a little easier.
+class Psych::Visitors::ToRuby
+
+  # This is the method for creating hashes. There may be problems
+  # with Yaml mappings that have tags.
+  def revive_hash hash, o
+    o.children.each_slice(2) { |k,v|
+      key = accept(k)
+      val = accept(v)
+
+      val = { "value" => val, "line" => v.line} # line is 0 based, so + 1
+
+      # Code dealing with << (for merging hashes) omitted.
+      # If you need this you will probably need to copy it
+      # in here. See the method:
+      # https://github.com/tenderlove/psych/blob/v2.0.13/lib/psych/visitors/to_ruby.rb#L333-L365
+
+      hash[key] = val
+    }
+    hash
+  end
+end