cwb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 563d71bbe20f53566a06c0629a80ce6e33db05a1
+  data.tar.gz: 38e305e7cdfe54117c905894be79b6dbaf7507f7
+SHA512:
+  metadata.gz: 832d40d55657589d91d9963e676dd361e6ce989bdcd7b732a7a1fa993be1c702dc188ed71e15103f5bf9cb2122f87426e5d5f1f9fa5e0b78fc230b1a09878c6c
+  data.tar.gz: 356ce42953d81ada654d99e51f7aa6d52300b9e4b8686df98ecb714a5787aedb38af16998401820cd6a3324b0908fd96a52b2bae806f3c1e6e4a25b01ff90b38

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+# Run the tests with console colored output
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2015-04-25)
+
+* Initial release

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,49 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joel Scheuner
+
+MIT License
+
+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,31 @@
+# Cloud WorkBench Client (CWB Client)
+
+Command line utility [cwb-client] acts as the client library in cloud VMs and allows for local testing (if not configured against a cwb-server).
+CWB Client helps you implement your own suites of benchmarks and optionally integrates them with the CWB framework.
+See https://github.com/sealuzh/cloud-workbench
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cwb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cwb
+
+## Usage
+
+See `Cwb::Client` Yardoc
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cwb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+task :test => :spec

data/bin/cwb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "cwb"
+Cwb::Cli.start(ARGV)

data/cwb.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cwb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cwb"
+  spec.version       = Cwb::VERSION
+  spec.executables   << 'cwb'
+  spec.authors       = ["Joel Scheuner"]
+  spec.email         = ["joel.scheuner.dev@gmail.com"]
+  spec.summary       = %q{Provides Cloud WorkBench (CWB) infrastructure for cloud VMs and local testing.}
+  spec.homepage      = "https://github.com/sealuzh/cloud-workbench"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "faraday", "~> 0.9.1"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+end

data/lib/cwb/benchmark.rb

@@ -0,0 +1,22 @@
+require "cwb/client"
+
+module Cwb
+  class Benchmark
+    def initialize(working_dir = Dir.pwd)
+      @cwb = Cwb::Client.instance
+      @working_dir = working_dir
+    end
+
+    def execute_in_working_dir
+      Dir.chdir @working_dir do
+        execute
+      end
+    end
+
+    # Intended to override
+    # @api
+    def execute
+      # Empty benchmarks do nothing
+    end
+  end
+end

data/lib/cwb/benchmark_suite.rb

@@ -0,0 +1,35 @@
+module Cwb
+  class BenchmarkSuite
+    def initialize(working_dir = Dir.pwd)
+      @cwb = Cwb::Client.instance
+      @working_dir = working_dir
+    end
+
+    def execute_suite(cwb_benchmarks)
+      execute_all(cwb_benchmarks)
+      @cwb.notify_finished_execution
+    rescue => error
+      @cwb.notify_failed_execution(error.message)
+      raise error
+    end
+
+    def execute_all(cwb_benchmarks)
+      cwb_benchmarks.each do |cwb_benchmark|
+        cwb_benchmark.execute_in_working_dir
+      end
+    end
+
+    # Lookup the implementation of a certain benchmark
+    def get(clazz, cwb_benchmarks)
+      cwb_benchmarks.select{|cwb_benchmark| cwb_benchmark.instance_of?(clazz) }.first
+    end
+
+    def get_list(clazzes, cwb_benchmarks)
+      list = []
+      clazzes.each do |clazz|
+        list << get(clazz, cwb_benchmarks)
+      end
+      list
+    end
+  end
+end

data/lib/cwb/cli.rb

@@ -0,0 +1,18 @@
+require "thor"
+require "cwb/parser_factory"
+
+module Cwb
+  class Cli < Thor
+    desc "execute BENCHMARK_FILE|BENCHMARK_DIRECTORY", "execute a benchmark or an entire collection of benchmark in a given directory with cwb"
+    option :aliases => :e
+    def execute(path)
+      Cwb::ParserFactory.build(path).execute
+    end
+    
+    desc "validates BENCHMARK_FILE|BENCHMARK_DIRECTORY", "performs basic validation of the class files and directory structure."
+    option :aliases => :v
+    def validate(path)
+      Cwb::ParserFactory.build(path).validate
+    end
+  end
+end

data/lib/cwb/client.rb

@@ -0,0 +1,138 @@
+require "singleton"
+require "csv"
+require "faraday"
+require "faraday_middleware"
+require "cwb/config"
+
+module Cwb
+  # Serves as cwb-server client library in cloud VMs (if configured against a cwb-server)
+  # or as standalone utility otherwise where cwb-server communication (e.g., metric submission)
+  # is logged to stdout.
+  # @api
+  class Client
+    include Singleton
+
+    # RESTful endpoints
+    VM_INSTANCE = "virtual_machine_instances"
+    METRIC_OBSERVATIONS = "metric_observations"
+
+    # Reconfigures the Client with a configuration object against a cwb-server.
+    # @api private
+    # @return [void]
+    def reconfigure(config)
+      @config = config
+      if @config.complete?
+        @connection = Faraday.new(:url => "http://#{@config.server}") do |f|
+          f.request :multipart
+          f.request :json
+          f.adapter Faraday.default_adapter
+        end
+      end
+    end
+
+    # Securly access nested attributes.
+    # @example Acess benchmark attribute hash
+    #          @cwb.deep_fetch("sysbench", "cli_options")
+    # @example Access node attribute (collected by ohai)
+    #          @cwb.deep_fetch("cpu", "0", "model_name")
+    # @return [String] an empty string if attribute cannot be found
+    def deep_fetch(*keys)
+      @config.deep_fetch(*keys)
+    end
+
+    # Submit a single metric
+    # @param metric_definition_id [String] the name of the CWB metric
+    # @param time [Integer] the UNIX timestamp when the metric was captured
+    # @param value [String (nominal-scale) or Numeric (otherwise)] the value of the metric
+    # @return [void]
+    def submit_metric(metric_definition_id, time, value)
+      if @config.complete?
+        submit_remote_metric(metric_definition_id, time, value)
+      else
+        puts "#{metric_definition_id},#{time},#{value}"
+      end
+    end
+
+    # Submit a csv file with metrics
+    # @param metric_definition_id [String] the name of the CWB metric
+    # @param csv_file [String] the path to the csv file containing the metrics
+    # @note the csv file must:
+    #       * have two columns: 'time' [Integer], 'value' [String (nominal-scale) or Numeric (otherwise)]
+    #       * be formatted without headers
+    # @return [void]
+    def submit_metrics(metric_definition_id, csv_file)
+      if @config.complete?
+        submit_remote_metrics(metric_definition_id, csv_file)
+      else
+        CSV.foreach(csv_file) do |row|
+          puts row.join(',')
+        end
+      end
+    end
+
+    # Notifies the cwb-server that the benchmark successfully completed.
+    # @note The cwb-server will shutdown all VMs of this executions.
+    # @return [void]
+    def notify_finished_execution
+      if @config.complete?
+        post_notify("/#{VM_INSTANCE}/complete_postprocessing", true)
+      else
+        puts "Notify finished postprocessing."
+      end
+    end
+
+    # Notifies the cwb-server that the benchmark failed during the execution
+    # @note The cwb-server will shutdown all VMs of this execution after a timeout (~15').
+    # @return [void]
+    def notify_failed_execution(message = "")
+      if @config.complete?
+        post_notify("/#{VM_INSTANCE}/complete_benchmark", false, message)
+      else
+        puts "Notify failure on running. (message suppressed to avoid redundant logging)"
+      end
+    end
+
+
+    private
+
+      # Create a standalone instance with an empty config per default
+      def initialize
+        @config = Cwb::Config.new
+      end
+
+      def submit_remote_metric(metric_definition_id, time, value)
+        body = {
+            :metric_observation => {
+              metric_definition_id: metric_definition_id,
+              provider_name: @config.provider_name,
+              provider_instance_id: @config.provider_instance_id,
+              time: time,
+              value: value
+            }
+        }
+        @connection.post "/#{METRIC_OBSERVATIONS}", body
+      end
+
+      def submit_remote_metrics(metric_definition_id, csv_file)
+        payload = {
+            metric_observation: {
+              metric_definition_id: metric_definition_id,
+              provider_name: @config.provider_name,
+              provider_instance_id: @config.provider_instance_id,
+              file: Faraday::UploadIO.new(csv_file, 'text/csv')
+            }
+        }
+        @connection.post "/#{METRIC_OBSERVATIONS}/import", payload
+      end
+
+      def post_notify(path, success = true, message = "", opts = {})
+        body = {
+            provider_name: @config.provider_name,
+            provider_instance_id: @config.provider_instance_id,
+            success: success.to_s,
+            message: message,
+        }.merge(opts)
+        @connection.post path, body
+      end
+  end
+end

data/lib/cwb/config.rb

@@ -0,0 +1,54 @@
+require "yaml"
+
+module Cwb
+  class Config
+    attr_accessor :node
+
+    def self.exists_in_dir?(dir)
+      File.exists?(self.config_file(dir))
+    end
+
+    def self.from_dir(dir)
+      self.from_file(self.config_file(dir))
+    end
+
+    def self.from_file(file)
+      self.new(YAML.load_file(file))
+    end
+
+    def initialize(node = {})
+      @node = node
+    end
+
+    def deep_fetch(*keys)
+      @node.deep_fetch(*keys, default: '')
+    end
+
+    # Determines whether all strictly required attributes
+    # that are necessary for communication with the cwb-server
+    # are available.
+    def complete?
+      args = [server, provider_name, provider_instance_id]
+      args.map { |value| value.empty? }.none?
+    end
+
+    def server
+      deep_fetch("cwb", "server")
+    end
+
+    def provider_name
+      deep_fetch("benchmark", "provider_name")
+    end
+
+    def provider_instance_id
+      deep_fetch("benchmark", "provider_instance_id")
+    end
+
+
+    private
+
+      def self.config_file(dir)
+        File.join(dir, "node.yml")
+      end
+  end
+end

data/lib/cwb/directory_parser.rb

@@ -0,0 +1,60 @@
+require "cwb/parser"
+require "cwb/benchmark_suite"
+
+module Cwb
+  class DirectoryParser < Parser
+    def validate
+      check_file_exists(benchmarks_file_path)
+      require_all(read_lines(benchmarks_file_path))
+    end
+
+    def delegate_execution
+      cwb_benchmarks = init_classes(read_lines(benchmarks_file_path))
+      benchmark_suite.execute_suite(cwb_benchmarks)
+    end
+
+    private
+
+      def read_lines(file)
+        benchmarks = []
+        File.readlines(file).each do |line|
+          stripped = line.strip
+          benchmarks << stripped unless stripped.empty?
+        end
+        benchmarks
+      end
+
+      def init_classes(benchmarks)
+        cwb_benchmarks = []
+        benchmarks.each do |benchmark|
+          stripped_benchmark = benchmark
+          cwb_benchmarks << Cwb.const_get(benchmark_class_name(stripped_benchmark)).new(working_dir(stripped_benchmark))
+        end
+        cwb_benchmarks
+      end
+
+      def working_dir(benchmark)
+        File.join(@path, benchmark)
+      end
+
+      def benchmark_class_name(benchmark)
+        benchmark.underscore.camelize
+      end
+
+      def require_all(benchmarks)
+        benchmarks.each do |benchmark|
+          class_file = benchmark_file(benchmark)
+          check_file_exists(class_file)
+          require class_file
+        end
+      end
+
+      def benchmark_file(benchmark)
+        File.join(@path, benchmark, "#{benchmark.underscore}.rb")
+      end
+
+      def benchmarks_file_path
+        File.join(@path, "benchmarks.txt")
+      end
+  end
+end

data/lib/cwb/directory_suite_parser.rb

@@ -0,0 +1,30 @@
+require "cwb/directory_parser"
+
+module Cwb
+  class DirectorySuiteParser < DirectoryParser
+    def self.suite_file_present?(path)
+      File.exists?(self.suite_file_path(path)) && !File.read(self.suite_file_path(path)).empty?
+    end
+
+    # Suite file does definitely exist, otherwise the usual
+    # direcoy parser implementation would have been chosen instead.
+    def validate
+      super
+      require_all(read_lines(suite_file_path))
+    end
+
+    def benchmark_suite
+      init_classes(read_lines(suite_file_path)).first
+    end
+
+    private
+
+    def self.suite_file_path(path)
+      File.join(path, "benchmark_suite.txt")
+    end
+
+    def suite_file_path
+      self.class.suite_file_path(@path)
+    end
+  end
+end

data/lib/cwb/file_parser.rb

@@ -0,0 +1,32 @@
+require "cwb/parser"
+
+module Cwb
+  class FileParser < Parser
+    def initialize(path)
+      super(path)
+      init_config(parent_dir)
+      init_config(working_dir)
+    end
+
+    def delegate_execution
+      filename = File.basename(@path, ".rb")
+      class_name = filename.camelize
+      cwb_benchmark = Cwb.const_get(class_name).new(working_dir)
+      benchmark_suite.execute_suite([cwb_benchmark])
+    end
+
+    def validate
+      check_file_exists(@path)
+      require @path
+    end
+
+    private
+    def working_dir
+      File.dirname(@path)
+    end
+
+    def parent_dir
+      File.dirname(working_dir)
+    end
+  end
+end

data/lib/cwb/parser.rb

@@ -0,0 +1,40 @@
+module Cwb
+  class Parser
+    def initialize(path)
+      @path = File.expand_path(path)
+      init_config(@path)
+    end
+
+    def init_config(dir)
+      if Cwb::Config.exists_in_dir?(dir)
+        config = Cwb::Config.from_dir(dir)
+        Cwb::Client.instance.reconfigure(config)
+      end
+    end
+
+    def execute
+      validate
+      delegate_execution
+    end
+
+    def validate
+      fail "Not implemented in abstract base class"
+    end
+
+    def delegate_execution
+      fail "Not implemented in abstract base class"
+    end
+
+    def benchmark_suite
+      Cwb::BenchmarkSuite.new(@path)
+    end
+
+    private
+
+    def check_file_exists(file)
+      unless File.exists?(file)
+        fail "No file found at: #{file}"
+      end
+    end
+  end
+end

data/lib/cwb/parser_factory.rb

@@ -0,0 +1,17 @@
+require "cwb/file_parser"
+require "cwb/directory_parser"
+require "cwb/directory_suite_parser"
+
+module Cwb
+  module ParserFactory
+    def self.build(path)
+      if File.directory?(path) && Cwb::DirectorySuiteParser.suite_file_present?(path)
+        Cwb::DirectorySuiteParser.new(path)
+      elsif File.directory?(path)
+        Cwb::DirectoryParser.new(path)
+      else
+        Cwb::FileParser.new(path)
+      end
+    end
+  end
+end

data/lib/cwb/version.rb

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

data/lib/cwb.rb

@@ -0,0 +1,19 @@
+require "cwb/version"
+
+module Cwb
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  # Add inflection methods to string
+  require "inflection"
+  String.send(:include, Inflection)
+
+  # Add deep_fetch to hash
+  require "hash_extension"
+  Hash.send(:include, HashExtension)
+
+  require "cwb/benchmark"
+  require "cwb/benchmark_suite"
+  require "cwb/cli"
+end