restassured_cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 802f2ba025cd683d386eb915a4441d585e20375b
+  data.tar.gz: 55e93899fa4eaa01fe6f3378458655b5b5ab2fc6
+SHA512:
+  metadata.gz: 30dc207df48d412bd7046e15ac7b4de01c224c227a9f6b6c61f0fa91943fe7557f66135e0a68313f03ff433afb942699ea32f0ae656ea69987736785366c42e1
+  data.tar.gz: 52f698dc147b55aa2bcc2bf7eb7e4916e29b08212c3d6377c043e18b56faab7fbdb63c4f097cda171b236d3713ddf23f2333f2526b599e0c85d4dc838a3907cf

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Intuit Inc. All rights reserved.
+
+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,139 @@
+# restassured_cli release notes
+
+## About
+
+Command line utility (CLI) to generate test projects and sample tests using [RestAssured BDD framework](https://github.com/jayway/rest-assured), a Java DSL for easy testing of REST services.
+
+## Release notes
+
+* v1.0.0 - First release with examples as presented in [StarWest 2015](http://starwest.techwell.com/sessions/starwest-2015/automate-rest-services-testing-restassured)
+
+## Getting started
+
+### To install as gem
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restassured_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restassured_cli
+
+### To run as ruby executable
+* Just run ./bin/restassured_cli
+
+## Usage
+
+```
+$ ./restassured_cli
+Usage: restassured_cli [-f] [-p projectVersion] [-j jdkVersion] <base package> <service name>
+Options
+  -f,--full           : full option, generates sample tests
+  -j,--jdk            : project JDK version (default: 1.7)
+  -p,--projectVersion : project version (default: 1.0.0-SNAPSHOT)
+  -h,--help           : display this screen
+
+Examples
+   restassured_cli com.intuit.samples smallbusiness
+   restassured_cli -p 1.0.0 -f com.intuit.samples smallbusiness
+
+$./restassured_cli -p 1.0.0 -f com.intuit.samples smallbusiness
+Created project for smallbusiness service ...
+
+smallbusiness
+          |── smallbusiness-service
+          |         |── src/main/java/
+          |         └── src/test/java/
+          └── testing
+                    |── smallbusiness-perf-tests
+                    |     └── jmeter/regression/
+                    |     |── src/main/java/com/intuit/samples/smallbusiness/tests/perf/
+                    |     └── src/main/resources/
+                    |                   └── testng-perf.xml
+                    |── smallbusiness-production-tests
+                    |     |── src/main/java/com/intuit/samples/smallbusiness/tests/production/
+                    |     └── src/main/resources/
+                    |                   └── testng-production.xml
+                    |── smallbusiness-service-tests
+                    |     |── src/main/java/com/intuit/samples/smallbusiness/tests/service/
+                    |     |── src/main/java/com/intuit/samples/smallbusiness/tests/serviceintegration/
+                    |     └── src/main/resources/
+                    |                   |── default/*.properties
+                    |                   |── ci/*.properties
+                    |                   |── qa/*.properties
+                    |                   |── e2e/*.properties
+                    |                   |── testng-ci.xml
+                    |                   |── testng-qa.xml
+                    |                   └── testng-e2e.xml
+                    └── smallbusiness-test-library
+                          └── src/main/java/com/intuit/samples/smallbusiness/tests/library/
+```
+
+## Maven
+
+* pom files
+ - **Root level pom** or project top level pom, should be replaced with your own project pom.
+ - testing/project-parent-pom/pom.xml, should contain all your project dependencies
+ - testing/project-test-runner/pom.xml, runs tests without recompiling and is used in Jenkins
+
+## How to run tests
+
+* Running test artifacts
+ - Tests are run *without* recompiling. Artifacts are downloaded and testng files are extracted.
+
+```
+$ cd testing
+$ mvn clean install
+
+$ cd testing/<project>-test-runner
+$ mvn clean install -U -P ci
+$ mvn clean install -U -P qa
+$ mvn clean install -U -P e2e
+$ mvn clean install -U -P perf
+```
+ - For profiles other than ci, qa, e2e, perf and production, create your own profiles in test-parent-pom.
+
+## Eclipse
+
+* To import testing project into Eclipse :
+
+ - cd testing; mvn eclipse:eclipse
+
+ - File > Import > Maven > Existing Maven Projects > Browse to testing root directory (all selections checked) and click Finish
+
+* To run tests for environments other than qa, add **-Dtargetenv=ci** in Run Configuration’s VM arguments/options.
+
+## Windows users
+
+* Steps to run CLI
+ -  Install Ruby from http://rubyinstaller.org/downloads/
+ -  In the directory where you install restassured_cli, run
+```
+c:\Ruby22-x64\bin\ruby.exe restassured_cli -p 1.0.0 -j 1.7 -f com.intuit.samples smallbusiness
+```
+
+## Tips
+
+* Updating project-test-library requires a "mvn install" before tests can pick up the change.
+* Remove sample test code in service-tests and test-library when you're done
+* TestNG xml files requires updating once you created tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eing/restassured_cli.
+
+## Contributors (thank you!)
+
+This release contains contributions from the following developers (in alphabetical order) across Intuit. Many others also contributed in different ways.
+* Baechul Kim
+* Todd Ekenstam
+
+## 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,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

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

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+begin
+  require "restassured_cli"
+  require "restassured_cli/userinterface"
+rescue LoadError
+  # if user does not have gem installed
+  puts "Detecting restassured_cli gem is not installed, fallback on local install"
+  $LOAD_PATH << __dir__ + '/../lib'
+  $LOAD_PATH << __dir__ + '/lib'
+  require "restassured_cli"
+  require "restassured_cli/userinterface"
+  puts "... Found and executing local install"
+end
+require "optparse"
+
+options = {}
+optparse = OptionParser.new do |opts|
+  options[:full] = false
+  opts.on('-f', '--full', 'full option to create sample tests') do
+    options[:full] = true
+  end
+
+  options[:projectVersion] = '1.0.0-SNAPSHOT'
+  opts.on('-p', '--projectVersion projectVersion', 'specify project version') do |version|
+    options[:projectVersion] = version
+  end
+
+  options[:jdkVersion] = '1.7'
+  opts.on('-j', '--jdk jdkVersion', 'jdk option to specify JDK version') do |jdkVersion|
+    options[:jdkVersion] = jdkVersion
+  end
+
+  opts.on('-h', '--help', 'display help') do
+    Display.help
+    exit
+  end
+end
+
+optparse.parse!
+if ARGV.length < 2
+  Display.help
+  exit
+end
+
+RestAssuredCLI::process(ARGV[0], ARGV[1], options)

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/lib/restassured_cli.rb

@@ -0,0 +1,77 @@
+require "restassured_cli/filenames"
+require "restassured_cli/userinterface"
+require "restassured_cli/createcontroller"
+
+module RestAssuredCLI
+
+  def self.process(firstArg, secondArg, options)
+    # checking required first argument for null
+    if firstArg.nil?
+      puts "Error: Base package name cannot be null\n\n"
+      Display.help
+      return
+    end
+    # checking required second argument for null
+    if secondArg.nil?
+      puts "Error: Service name cannot be null\n\n"
+      Display.help
+      return
+    end
+
+    # setting default values
+    if options.nil?
+      options[:jdkVersion] = "1.7"
+      options[:projectVersion] = "1.0.0"
+      options[:full] = false
+    end
+    if options[:jdkVersion].nil?
+      options[:jdkVersion] = "1.7"
+    end
+    if options[:projectVersion].nil?
+      options[:projectVersion] = "1.0.0"
+    end
+    if options[:full].nil?
+      options[:full] = false
+    end
+
+    $baseJavaPackage = firstArg
+
+    # servicename = test module name
+    $serviceName = secondArg
+
+    # projectName = project root and can contain dashes
+    $projectName = $serviceName
+
+    # groupId = java test package names cannot contain dashes
+    baseJavaPackageDashesRemoved = $baseJavaPackage.gsub(/-/, '')
+    serviceNameDashesRemoved = $serviceName.gsub(/-/, '')
+    $groupId = baseJavaPackageDashesRemoved + "." + serviceNameDashesRemoved
+
+    # packageName = test directory path replaces . with /
+    $packageName = baseJavaPackageDashesRemoved.gsub(/\./,'/') + '/' + serviceNameDashesRemoved
+
+    filegen = CreateController.new("#{$projectName}", "#{$groupId}", "#{$serviceName}", "#{$packageName}")
+    filegen.setJdkVersion(options[:jdkVersion])
+    filegen.setProjectVersion(options[:projectVersion])
+    files = FileNames.new("#{$serviceName}", "#{$packageName}")
+    baseCopyToDir = "#{$projectName}/testing"
+
+    # Create common directories
+    filegen.mkdir_common
+    filegen.mkdir_service_default
+    if options[:full]
+      filegen.mkdir_service_full
+      files.full.each do |filename|
+        filegen.copyFilesWithoutOverwriting "#{filename[0]}", "#{baseCopyToDir}/#{filename[1]}"
+      end
+    end
+    # Default option
+    files.default.each do |filename|
+      filegen.copyFilesWithoutOverwriting "#{filename[0]}", "#{baseCopyToDir}/#{filename[1]}"
+    end
+    files.testRunner.each do |filename|
+      filegen.copyFilesWithoutOverwriting "#{filename[0]}", "#{baseCopyToDir}/#{filename[1]}"
+    end
+    Display.results
+  end
+end

data/lib/restassured_cli/createcontroller.rb

@@ -0,0 +1,81 @@
+require "fileutils"
+
+# Class creates directories and copy files for restassured cli tool.
+class CreateController
+
+  def initialize(projectName, groupId, serviceName, packageName)
+    # required parameters
+    @projectName = projectName
+    @groupId = groupId
+    @serviceName = serviceName
+    @packageName = packageName
+    # optional parameters
+    @version = '1.0.0-SNAPSHOT'
+    @jdkVersion = '1.7'
+  end
+
+  def mkdir_common
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-runner"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-parent-pom"
+  end
+
+  # create directories for basic option
+  def mkdir_service_default
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/java/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/resources/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/java/#{@packageName}/tests/service"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/java/#{@packageName}/tests/serviceintegration"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/resources/default"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/resources/qa"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/resources/ci"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-service-tests/src/main/resources/e2e"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-library/src/main/java/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/base"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-perf-tests/src/main/java/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-perf-tests/src/main/resources/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-perf-tests/src/main/scripts/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-production-tests/src/main/java/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-production-tests/src/assembly/"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-production-tests/src/main/resources/production"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-production-tests/src/main/java/#{@packageName}/tests/production"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-perf-tests/src/main/java/#{@packageName}/tests/perf"
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/base"
+  end
+
+  # create tests directories for full option
+  def mkdir_service_full
+    FileUtils.mkdir_p "#{@projectName}/testing/#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/schema"
+  end
+
+
+  def setJdkVersion(version)
+    @jdkVersion = version
+  end
+
+  def setProjectVersion(version)
+    @version = version
+  end
+
+  # copy poms, testng, tests files and replace with groupId, projectName and serviceName
+  def replaceStringsInFile(filename)
+    text = File.read(filename)
+    text = text.gsub(/GROUPID/, @groupId)
+    text = text.gsub(/PROJECTNAME/, @projectName)
+    text = text.gsub(/SERVICENAME/, @serviceName)
+    text = text.gsub(/PACKAGENAME/, @serviceName)
+    text = text.gsub(/PROJECTVERSION/, @version)
+    text = text.gsub(/JDKVERSION/, @jdkVersion)
+    File.open(filename, "w") { |file| file << text }
+  end
+
+  # copy a file only when it does not already exist
+  def copyFilesWithoutOverwriting(filenameFrom, filenameTo)
+    unless File.file?(filenameTo)
+      fullPath = __dir__ + '/source/maven/testing/' + filenameFrom
+      FileUtils.cp fullPath, filenameTo
+      replaceStringsInFile filenameTo
+    end
+  end
+
+end

data/lib/restassured_cli/filenames.rb

@@ -0,0 +1,69 @@
+# Class to maintain filenames to copy
+class FileNames
+
+  attr_reader :default
+  attr_reader :full
+  attr_reader :testRunner
+
+  def initialize(serviceName, packageName)
+    @serviceName = serviceName
+    @packageName = packageName
+    initializeDefault
+    initializeFull
+    initializeTestRunner
+  end
+
+  def initializeDefault
+    @default = [
+        ["../pom.xml", "../pom.xml"],
+        ["README.md", "README.md"],
+        ["pom.xml", "pom.xml"],
+        ["sampleservice-perf-tests/pom.xml", "#{@serviceName}-perf-tests/pom.xml"],
+        ["sampleservice-perf-tests/testng-perf-notests.xml", "#{@serviceName}-perf-tests/src/main/resources/testng-perf.xml"],
+        ["sampleservice-production-tests/pom.xml", "#{@serviceName}-production-tests/pom.xml"],
+        ["sampleservice-production-tests/logback.xml", "#{@serviceName}-production-tests/src/main/resources/logback.xml"],
+        ["sampleservice-production-tests/testng-production.xml", "#{@serviceName}-production-tests/src/main/resources/testng-production.xml"],
+        ["sampleservice-test-library/pom.xml", "#{@serviceName}-test-library/pom.xml"],
+        ["sampleservice-test-library/default/ServiceTestBase.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/base/ServiceTestBase.java"],
+        ["sampleservice-test-library/default/BaseConstant.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/base/BaseConstant.java"],
+        ["sampleservice-test-library/default/InternalConfigManager.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/base/InternalConfigManager.java"],
+        ["sampleservice-test-library/default/sample/base/Constant.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/base/Constant.java"],
+        ["sampleservice-test-library/default/sample/base/SampleTestBase.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/base/SampleTestBase.java"],
+        ["sampleservice-service-tests/pom.xml", "#{@serviceName}-service-tests/pom.xml"],
+        ["sampleservice-service-tests/logback.xml", "#{@serviceName}-service-tests/src/main/resources/logback.xml"],
+        ["sampleservice-service-tests/resources/default/sample.properties", "#{@serviceName}-service-tests/src/main/resources/default/sample.properties"],
+        ["sampleservice-service-tests/resources/ci/sample.properties", "#{@serviceName}-service-tests/src/main/resources/ci/sample.properties"],
+        ["sampleservice-service-tests/resources/qa/sample.properties", "#{@serviceName}-service-tests/src/main/resources/qa/sample.properties"],
+        ["sampleservice-service-tests/resources/e2e/sample.properties", "#{@serviceName}-service-tests/src/main/resources/e2e/sample.properties"],
+        ["sampleservice-service-tests/default/SampleTest.java", "#{@serviceName}-service-tests/src/main/java/#{@packageName}/tests/service/SampleTest.java"],
+        ["sampleservice-service-tests/default/testng-ci.xml", "#{@serviceName}-service-tests/src/main/resources/testng-ci.xml"],
+        ["sampleservice-service-tests/default/testng-qa.xml", "#{@serviceName}-service-tests/src/main/resources/testng-qa.xml"],
+        ["sampleservice-service-tests/default/testng-e2e.xml", "#{@serviceName}-service-tests/src/main/resources/testng-e2e.xml"]
+    ]
+  end
+
+  def initializeFull
+    @full = [
+        ["sampleservice-test-library/full/sample/base/Constant.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/base/Constant.java"],
+        ["sampleservice-test-library/full/sample/base/SampleTestBase.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/base/SampleTestBase.java"],
+        ["sampleservice-test-library/full/SampleServiceHelper.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/sample/SampleServiceHelper.java"],
+        ["sampleservice-test-library/full/Customer.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/schema/Customer.java"],
+        ["sampleservice-test-library/full/Phone.java", "#{@serviceName}-test-library/src/main/java/#{@packageName}/tests/library/schema/Phone.java"],
+        ["sampleservice-service-tests/full/SampleComponentTest.java", "#{@serviceName}-service-tests/src/main/java/#{@packageName}/tests/service/SampleComponentTest.java"],
+        ["sampleservice-service-tests/full/SampleServiceIntegrationTest.java", "#{@serviceName}-service-tests/src/main/java/#{@packageName}/tests/serviceintegration/SampleServiceIntegrationTest.java"],
+        ["sampleservice-service-tests/full/testng-qa.xml", "#{@serviceName}-service-tests/src/main/resources/testng-qa.xml"],
+        ["sampleservice-service-tests/full/testng-ci.xml", "#{@serviceName}-service-tests/src/main/resources/testng-ci.xml"],
+        ["sampleservice-service-tests/full/testng-e2e.xml", "#{@serviceName}-service-tests/src/main/resources/testng-e2e.xml"],
+        ["sampleservice-perf-tests/LoginTest.java", "#{@serviceName}-perf-tests/src/main/java/#{@packageName}/tests/perf/LoginTest.java"],
+        ["sampleservice-perf-tests/testng-perf.xml", "#{@serviceName}-perf-tests/src/main/resources/testng-perf.xml"]
+    ]
+  end
+
+  def initializeTestRunner
+    @testRunner = [
+        ["sampleservice-test-runner/pom.xml", "#{@serviceName}-test-runner/pom.xml"],
+        ["sampleservice-test-parent-pom/pom.xml", "#{@serviceName}-test-parent-pom/pom.xml"]
+    ]
+  end
+
+end