neustar_pfm_cli 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31e10ae19309549fbb8eb80086dc6a1c15b38a3d
+  data.tar.gz: 8ef4098d878dddd220e18ce0b8dd38f57b1d818b
+SHA512:
+  metadata.gz: 1d6c941726dd0f34508642f4e2ece92b9a6190e0998d704f97d9d6f5e75c8c9056782e64c28806b47ec9a923ef1c2939f403466ca4d1e733aeb10d97895ab2df
+  data.tar.gz: f3270aa03810d943ad6e16776587e47ca44d84547f4da71d289a1c8335924975a0a423b40f53baae98c2a7b0e3299f50b303ff7be29209d7e0f620da31a07655

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,109 @@
+# neustar-pfm-cli
+
+## About
+
+- Neustar WebPerformance Management API を叩く非公認コマンドラインツール
+- 負荷試験シナリオスクリプトのアップロード、Local Validate 等を行うことが出来る
+- 負荷試験のスケジュール等を行うことが出来る
+
+## Reference
+
+- https://apidocs.wpm.neustar.biz/loadtesting
+- https://apidocs.wpm.neustar.biz/script
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'neustar_pfm_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neustar_pfm_cli
+
+## Usage
+
+### 環境変数
+
+- API キー及び、Shared Secret
+
+```sh
+export NEUSTAR_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxx"
+export NEUSTAR_SHARED_KEY="xxxxxxx"
+```
+
+- Local Validator
+
+```sh
+export NEUSTAR_LOCAL_VALIDATOR_PATH="/path/to/local-validator-4.34.17/bin/validator"
+```
+
+### loadtest
+
+- ls ... 負荷試験一覧を取得する
+
+```sh
+bundle exec bin/npc-loadtest ls | jq '.data.items[]'
+```
+
+- del ... 指定した負荷試験を削除する
+
+```sh
+bundle exec bin/npc-loadtest del -i $(bundle exec bin/npc-loadtest ls | jq '.data.items[].id')
+```
+
+- sc ... 指定した負荷試験をスケジュールする
+
+```sh
+bundle exec bin/npc-loadtest sc -f loadtest.yml
+```
+
+loadtest.yml は以下のように定義する。
+
+```yaml
+name: "myloadtest"
+region: "AP_NORTHEAST"
+scripts:
+  - percentage: 100
+      scriptId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      parts:
+  - duration: 5
+      maxUsers: 10
+      type: "RAMP"
+```
+
+### scripting
+
+- ls ... 負荷試験シナリオスクリプト一覧を取得する
+
+```sh
+bundle exec bin/npc-scripting ls | jq '.data.items[]'
+```
+
+- val ... 指定した負荷試験シナリオスクリプトを Local Validator を利用してチェックする
+
+```sh
+bundle exec bin/npc-scripting val -f path/to/script.js
+```
+- up ... 指定した負荷試験シナリオスクリプトをアップロードする
+
+```sh
+bundle exec bin/npc-scripting up -n script_name -f path/to/script.js -t tag1,tag2 -d description
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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]/neustar_pfm_cli.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+# require "thor"
+require "neustar_pfm_cli/loadtest"
+
+NeustarPfmCli::LoadTest.start

data/bin/npc-scripting

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require "thor"
+require "neustar_pfm_cli/scripting"
+
+NeustarPfmCli::Scripting.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/lib/neustar_pfm_cli.rb

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

data/lib/neustar_pfm_cli/common.rb

@@ -0,0 +1,13 @@
+require "digest/md5"
+require "faraday"
+
+def request 
+  $api_key   = ENV["NEUSTAR_API_KEY"] 
+  shared_key = ENV["NEUSTAR_SHARED_KEY"]
+  timestamp  = Time.now.to_i
+  $sig       = Digest::MD5.hexdigest($api_key + shared_key + timestamp.to_s)
+
+  Faraday::Connection.new(:url => 'https://api.neustar.biz') do |builder|
+    builder.use Faraday::Adapter::NetHttp
+  end
+end

data/lib/neustar_pfm_cli/loadtest.rb

@@ -0,0 +1,61 @@
+require "neustar_pfm_cli/common"
+require "thor"
+require "yaml"
+require "json"
+
+module NeustarPfmCli
+  class LoadTest < Thor
+    desc "list", "負荷試験の一覧を取得する"
+    method_option :limit, :type => :string, :aliases => '-l', :desc => "取得する件数を指定", :default => "10"
+    def ls
+      begin
+        res = request.get "/performance/load/1.0/list?limit=#{options[:limit]}&apikey=#{$api_key}&sig=#{$sig}"
+        puts res.body
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+      end
+    end
+
+    desc "delete", "負荷試験を削除する"
+    method_option :id, :type => :string, :aliases => '-i', :desc => "loadTestId を指定する"
+    def del
+      begin
+        res = request.delete "/performance/load/1.0/#{options[:id]}/delete?apikey=#{$api_key}&sig=#{$sig}"
+        puts res.body
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+      end
+    end
+
+    desc "sc", "負荷試験をスケジュールする"
+    method_option :file, :type => :string, :aliases => '-f', :desc => "負荷試験定義ファイルのパスを指定"
+    def sc
+      begin
+        params = load_loadtest_file(options[:file])
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+      end
+
+      begin
+        res = request.post do |req|
+          req.url "/performance/load/1.0/schedule?apikey=#{$api_key}&sig=#{$sig}"
+          req.headers["Content-Type"] = "application/json"
+          puts req.body = params.to_json
+        end
+        puts res.body
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+        exit 1
+      end
+
+    end
+
+    private
+
+    def load_loadtest_file(filename)
+      params = YAML.load_file(filename) 
+      return params
+    end
+
+  end
+end

data/lib/neustar_pfm_cli/scripting.rb

@@ -0,0 +1,81 @@
+require "neustar_pfm_cli/common"
+require "yaml"
+require "json"
+require "open3"
+
+module NeustarPfmCli
+  class Scripting < Thor
+
+    desc "list", "シナリオスクリプト一覧を取得する"
+    method_option :limit, :type => :string, :aliases => '-l', :desc => "取得する件数を指定", :default => "10"
+    def ls
+      begin
+        res = request.get "/performance/script/1.0/ValidScripts/?limit#{options[:limit]}&apikey=#{$api_key}&sig=#{$sig}"
+        puts res.body
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+        exit 1
+      end
+    end
+
+    desc "validate", "シナリオスクリプトを Local Validator を使って validate する"
+    method_option :file, :type => :string, :aliases => '-f', :desc => "スクリプトファイルのパスを指定"
+    def val
+      begin
+        unless ENV["NEUSTAR_LOCAL_VALIDATOR_PATH"] == nil then
+          Open3.popen3("#{ENV["NEUSTAR_LOCAL_VALIDATOR_PATH"]} -verbose #{options[:file]}") do |stdin, stdout, stderr|
+            puts "\e[32m" + stdout.read + "\e[0m"
+            puts "\e[33m" + stderr.read + "\e[0m"
+          end
+        else
+          puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] 環境変数 NEUSTAR_LOCAL_VALIDATOR_PATH に Local Validator のパスを指定して下さい!!"
+          exit 1
+        end
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+        exit 1
+      end
+    end
+  
+    desc "upload", "シナリオスクリプトをアップロードする"
+    method_option :name, :type => :string, :aliases => '-n', :desc => "スクリプト名を指定"
+    method_option :file, :type => :string, :aliases => '-f', :desc => "スクリプトファイルのパスを指定"
+    method_option :tags, :type => :string, :aliases => '-t', :desc => "スクリプトの Tag を指定", :require => false
+    method_option :desc, :type => :string, :aliases => '-d', :desc => "スクリプトの Description を指定", :require => false
+    def up
+
+      begin
+        tags = { "tags" => options[:tags].split(",") }
+        desc = { "description" => options[:desc] }
+        params = tags.merge(desc)
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+      end
+
+      begin
+        res = request.post do |req|
+          req.url "/performance/script/1.0/upload/body?apikey=#{$api_key}&sig=#{$sig}"
+          req.headers["Content-Type"] = "application/json"
+          puts req.body = {
+            "name": options[:name],
+            "scriptBody": load_scenario_file(options[:file])
+          }.merge(params).to_json
+        end
+        puts res.body
+      rescue => e
+        puts "[" + "\e[31m" + "ERROR" + "\e[0m" + "] #{e}"
+        exit 1
+      end
+    end
+
+    private
+
+    def load_scenario_file(file_name)
+      file = open(file_name)
+      scenario = file.read
+      file.close
+      return scenario
+    end
+  
+  end
+end

data/lib/neustar_pfm_cli/version.rb

@@ -0,0 +1,3 @@
+module NeustarPfmCli
+  VERSION = "0.0.2"
+end

data/neustar_pfm_cli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neustar_pfm_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neustar_pfm_cli"
+  spec.version       = NeustarPfmCli::VERSION
+  spec.authors       = ["inokappa"]
+  spec.email         = ["inokara at gmail.com"]
+
+  spec.summary       = %q{Command Line Tool for Neustar WebPerformance Management API}
+  spec.description   = %q{Command Line Tool for Neustar WebPerformance Management API}
+  spec.homepage      = "https://github.com/inokappa"
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "thor"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: neustar_pfm_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- inokappa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: thor
+  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'
+description: Command Line Tool for Neustar WebPerformance Management API
+email:
+- inokara at gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/npc-loadtest
+- bin/npc-scripting
+- bin/setup
+- lib/neustar_pfm_cli.rb
+- lib/neustar_pfm_cli/common.rb
+- lib/neustar_pfm_cli/loadtest.rb
+- lib/neustar_pfm_cli/scripting.rb
+- lib/neustar_pfm_cli/version.rb
+- neustar_pfm_cli.gemspec
+homepage: https://github.com/inokappa
+licenses: []
+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.4
+signing_key: 
+specification_version: 4
+summary: Command Line Tool for Neustar WebPerformance Management API
+test_files: []