wss_agent 0.0.15

data/spec/fixtures/wss_agent.yml

@@ -0,0 +1,9 @@
+---
+url: http://saas.whitesourcesoftware.com
+token: 11111111-1111-1111-1111-111111111112
+check_policies: false
+agent: bundler-plugin
+agent_version: '1.0'
+product: 'Test product'
+product_version: '1.0.1'
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+Bundler.setup
+require 'faraday'
+require 'wss_agent'
+require 'webmock/rspec'
+require 'timecop'
+
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.allow_http_connections_when_no_cassette = false
+end
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+
+end

data/spec/wss_agent/cli_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe WssAgent::CLI, vcr: true  do
+
+  let(:cli) { WssAgent::CLI.new }
+  subject { cli }
+
+  context 'config' do
+    let(:output) { capture(:stdout) { subject.config } }
+    it "should create config file" do
+      expect(output).to include("Created the config file: wss_agent.yml")
+    end
+  end
+
+  context 'list' do
+    let(:output) { capture(:stdout) { subject.list } }
+    let(:list) {
+      [
+        {"groupId"=>"rake", "artifactId"=>"rake-10.4.2.gem", "version"=>"10.4.2", "sha1"=>"abfbf4fe8d3011f13f922adc81167af76890a627", "optional"=>false, "children"=>[], "exclusions"=>[]},
+        {"groupId"=>"addressable", "artifactId"=>"addressable-2.3.6.gem", "version"=>"2.3.6", "sha1"=>"dc3bdabbac99b05c3f9ec3b066ad1a41b6b55c55", "optional"=>false, "children"=>[], "exclusions"=>[]}]
+    }
+    it "returns a list dependies" do
+      expect(WssAgent::Specifications).to receive(:list).and_return(list)
+
+      expect(output).to eq("[\n    \e[1;37m[0] \e[0m{\n           \"groupId\"\e[0;37m => \e[0m\e[0;33m\"rake\"\e[0m,\n        \"artifactId\"\e[0;37m => \e[0m\e[0;33m\"rake-10.4.2.gem\"\e[0m,\n           \"version\"\e[0;37m => \e[0m\e[0;33m\"10.4.2\"\e[0m,\n              \"sha1\"\e[0;37m => \e[0m\e[0;33m\"abfbf4fe8d3011f13f922adc81167af76890a627\"\e[0m,\n          \"optional\"\e[0;37m => \e[0m\e[1;31mfalse\e[0m,\n          \"children\"\e[0;37m => \e[0m[],\n        \"exclusions\"\e[0;37m => \e[0m[]\n    },\n    \e[1;37m[1] \e[0m{\n           \"groupId\"\e[0;37m => \e[0m\e[0;33m\"addressable\"\e[0m,\n        \"artifactId\"\e[0;37m => \e[0m\e[0;33m\"addressable-2.3.6.gem\"\e[0m,\n           \"version\"\e[0;37m => \e[0m\e[0;33m\"2.3.6\"\e[0m,\n              \"sha1\"\e[0;37m => \e[0m\e[0;33m\"dc3bdabbac99b05c3f9ec3b066ad1a41b6b55c55\"\e[0m,\n          \"optional\"\e[0;37m => \e[0m\e[1;31mfalse\e[0m,\n          \"children\"\e[0;37m => \e[0m[],\n        \"exclusions\"\e[0;37m => \e[0m[]\n    }\n]\n")
+
+    end
+  end
+
+  context 'update' do
+    let(:output) { capture(:stdout) { subject.update } }
+    context 'when not found token' do
+      it 'should display error message' do
+        expect(output).to eq("\e[0;33m\"Can't find Token, please add your Whitesource API token in the wss_agent.yml file\"\e[0m\n")
+      end
+    end
+    it 'should display results' do
+      expect(WssAgent::Specifications).to receive(:update).and_return([])
+      expect(output).to eq("")
+    end
+  end
+
+  context 'check_policies' do
+    let(:output) { capture(:stdout) { subject.check_policies } }
+    it 'should display results' do
+      expect(WssAgent::Specifications).to receive(:check_policies).and_return([])
+      expect(output).to eq("")
+    end
+  end
+
+  context 'version' do
+    let(:output) { capture(:stdout) { subject.version } }
+    it 'should display version' do
+      expect(output).to eq("#{WssAgent::VERSION}\n")
+    end
+  end
+end

data/spec/wss_agent/client_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe WssAgent::Client, vcr: true  do
+  let(:bad_request_response) {
+    {"envelopeVersion"=>"2.1.0", "status"=>2, "message"=>"Illegal arguments", "data"=>"Unsupported agent: null"}
+  }
+  let(:success_response) {
+    "{\"envelopeVersion\":\"2.1.0\",\"status\":1,\"message\":\"ok\",\"data\":\"{\\\"organization\\\":\\\"Tom Test\\\",\\\"updatedProjects\\\":[],\\\"createdProjects\\\":[]}\"}"
+  }
+  let(:server_error_response) {
+    "<html><head><title>JBoss Web/7.0.13.Final - Error report</title><style><!--H1 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;} H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;} H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;} BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;} B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;} P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}A {color : black;}A.name {color : black;}HR {color : #525D76;}--></style> </head><body><h1>HTTP Status 500 - </h1><HR size=\"1\" noshade=\"noshade\"><p><b>type</b> Exception report</p><p><b>message</b> <u></u></p><p><b>description</b> <u>The server encountered an internal error () that prevented it from fulfilling this request.</u></p><p><b>exception</b> <pre>java.lang.NullPointerException\n\tcom.wss.service.agent.impl.AgentRequestParams.extractUpdateParams(AgentRequestParams.java:155)\n\tcom.wss.service.agent.impl.AgentRequestParams.fromHttpRequest(AgentRequestParams.java:133)\n\tcom.wss.service.agent.AgentServlet.doPost(AgentServlet.java:71)\n\tjavax.servlet.http.HttpServlet.service(HttpServlet.java:754)\n\tjavax.servlet.http.HttpServlet.service(HttpServlet.java:847)\n</pre></p><p><b>note</b> <u>The full stack trace of the root cause is available in the JBoss Web/7.0.13.Final logs.</u></p><HR size=\"1\" noshade=\"noshade\"><h3>JBoss Web/7.0.13.Final</h3></body></html>"
+  }
+
+  let(:wss_client) { WssAgent::Client.new }
+
+  before do
+    allow(WssAgent::Configure).to receive_messages(token: 'xxxxxx')
+  end
+
+
+  describe '#payload' do
+
+    it 'should return request params' do
+      Timecop.freeze(Time.now) do
+        payload = {
+          agent: "bundler-plugin",
+          agentVersion: "1.0",
+          token: "xxxxxx",
+          product: "",
+          productVersion: "",
+          timeStamp: Time.now.to_i,
+          diff: "[{\"coordinates\":{\"artifactId\":\"wss_agent\",\"version\":\"#{WssAgent::VERSION}\"},\"dependencies\":{}}]"
+        }
+
+        expect(wss_client.payload({})).to eq(payload)
+      end
+    end
+  end
+
+  describe '#diff' do
+    let(:diff) {
+      "[{\"coordinates\":{\"artifactId\":\"wss_agent\",\"version\":\"#{WssAgent::VERSION}\"},\"dependencies\":[{\"groupId\":\"bacon\",\"artifactId\":\"bacon-1.2.0.gem\",\"version\":\"1.2.0\",\"sha1\":\"xxxxxxxxxxxxxxxxxxxxxxx\",\"optional\":\"\",\"children\":\"\",\"exclusions\":\"\"}]}]"
+    }
+    let(:gem_list) {
+      [
+        {
+          'groupId' => 'bacon',
+			    'artifactId' => 'bacon-1.2.0.gem',
+			    'version' => '1.2.0',
+          'sha1' => 'xxxxxxxxxxxxxxxxxxxxxxx',
+          'optional' => '',
+          'children' => '',
+          'exclusions' => ''
+        }
+      ]
+    }
+    it 'should diff of gem list' do
+      expect(wss_client.diff(gem_list)).to eq(diff)
+    end
+  end
+
+
+  describe '#update' do
+
+    context 'success' do
+      before do
+        stub_request(:post, "http://saas.whitesourcesoftware.com/agent").
+          to_return(status: 200,
+                    body: success_response,
+                    headers: {})
+
+      end
+
+      subject { wss_client.update(WssAgent::Specifications.list) }
+
+      it 'response should be success' do
+        expect(subject).to be_success
+      end
+      it 'should return message response' do
+        expect(subject.message).to eq("White Source update results: \n  White Source organization: Tom Test \n  No new projects found \n\n  No projects were updated \n")
+      end
+      it 'should return status of response' do
+        expect(subject.status).to eq(1)
+      end
+      it 'should response json data' do
+        expect(subject.data).to eq({"organization"=>"Tom Test", "updatedProjects"=>[], "createdProjects"=>[]})
+      end
+    end
+
+    context 'bad request' do
+
+    end
+
+    context 'server error' do
+      before do
+        stub_request(:post, "http://saas.whitesourcesoftware.com/agent").
+          to_return(status: 200,
+                    body: server_error_response,
+                    headers: {})
+
+      end
+      subject { wss_client.update(WssAgent::Specifications.list) }
+      it 'response should be success' do
+        expect(subject).to_not be_success
+      end
+      it 'should return message response' do
+        expect(subject.message).to eq(server_error_response)
+      end
+      it 'should return status of response' do
+        expect(subject.status).to eq(WssAgent::Response::SERVER_ERROR_STATUS)
+      end
+      it 'should response json data' do
+        expect(subject.data).to be_nil
+      end
+    end
+
+    context 'server timeout' do
+      before do
+        stub_request(:post, "http://saas.whitesourcesoftware.com/agent").
+          to_timeout
+      end
+      subject { wss_client.update(WssAgent::Specifications.list) }
+      it 'response should be success' do
+        expect(subject).to_not be_success
+      end
+      it 'should return message response' do
+        expect(subject.message).to eq("Excon::Errors::Timeout")
+      end
+      it 'should return status of response' do
+        expect(subject.status).to eq(WssAgent::Response::SERVER_ERROR_STATUS)
+      end
+      it 'should response json data' do
+        expect(subject.data).to be_nil
+      end
+    end
+  end
+end

data/spec/wss_agent/configure_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe WssAgent::Configure  do
+  let(:default_config) {
+    {
+      'url' => 'http://saas.whitesourcesoftware.com/agent',
+      'token'=>'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+      "check_policies"=>false,
+      'agent' => 'bundler-plugin',
+      'agent_version' => '1.0',
+      'product' => '',
+      'product_version' => '',
+      'coordinates' => {"artifact_id"=>"", "version"=>""}
+    }
+  }
+
+  describe '.default_path' do
+    it 'should return path of default config' do
+      expect(WssAgent::Configure.default_path).to match(/\/lib\/config\/default\.yml\Z/)
+    end
+  end
+
+  describe '.exist_default_config?' do
+    it 'should be true' do
+      expect(WssAgent::Configure.exist_default_config?).to be true
+    end
+  end
+
+  describe '.default' do
+    it 'should default config' do
+      expect(WssAgent::Configure.default).to eq(default_config)
+    end
+  end
+
+  describe '.current_path' do
+    it 'should return locally config path' do
+      expect(WssAgent::Configure.current_path).to match(/wss_agent\.yml\Z/)
+    end
+  end
+
+  describe '.check_policies' do
+    context 'default' do
+      it 'should be "false"' do
+        expect(WssAgent::Configure['check_policies']).to be false
+      end
+    end
+  end
+
+  describe '.current' do
+    context 'when locally config is not found' do
+      it 'should return default config' do
+        allow(WssAgent::Configure).to receive(:current_path).and_return('miss.yml')
+        expect(WssAgent::Configure.current).to eq(default_config)
+      end
+    end
+    context 'when locally config is found' do
+      before do
+        allow(WssAgent::Configure).to receive(:current_path)
+                                       .and_return(File.join(File.expand_path('../..', __FILE__), 'fixtures/wss_agent.yml'))
+      end
+      it 'should return locally config' do
+        expect(WssAgent::Configure.current).to eq({
+                                                    "url" => "http://saas.whitesourcesoftware.com",
+                                                    "token" => "11111111-1111-1111-1111-111111111112",
+                                                    "check_policies" => false,
+                                                    "agent" => "bundler-plugin",
+                                                    "agent_version" => "1.0",
+                                                    "coordinates" => {"artifact_id"=>"", "version"=>""},
+                                                    "product" => "Test product",
+                                                    "product_version" => "1.0.1"
+                                                  })
+      end
+    end
+  end
+
+  describe '.url' do
+    context 'when url is empty' do
+      before do
+        allow(WssAgent::Configure).to receive_messages(current: {})
+      end
+      it 'should cause an exception' do
+        expect{ WssAgent::Configure.url }.to raise_error(WssAgent::ApiUrlNotFound)
+      end
+    end
+    context 'when url is exist' do
+      it 'should return url' do
+        expect(WssAgent::Configure.url).to eq('http://saas.whitesourcesoftware.com')
+      end
+    end
+  end
+
+  describe '.token' do
+    context 'when token is not found' do
+      it 'should cause an exception' do
+        expect{ WssAgent::Configure.token }.to raise_error(WssAgent::TokenNotFound)
+      end
+    end
+    context 'when token is found' do
+      let(:config) {
+        {
+          'url' => 'http://saas.whitesourcesoftware.com',
+          'token' => '11111111-1111-1111-1111-111111111111'
+        }
+      }
+      before do
+        allow(WssAgent::Configure).to receive_messages(current: config)
+      end
+
+      it 'should return token' do
+        expect(WssAgent::Configure.token).to eq('11111111-1111-1111-1111-111111111111')
+      end
+    end
+  end
+
+  describe '.agent' do
+    it 'should be "bundler-plugin"' do
+      expect(WssAgent::Configure['agent']).to eq('bundler-plugin')
+    end
+  end
+
+  describe '.agent_version' do
+    it 'should be "1.0"' do
+      expect(WssAgent::Configure['agent_version']).to eq('1.0')
+    end
+  end
+
+  describe '.product' do
+    before do
+      allow(WssAgent::Configure).to receive(:current_path)
+                                     .and_return(File.join(File.expand_path('../..', __FILE__), 'fixtures/wss_agent.yml'))
+    end
+
+    it 'should be "Test product"' do
+      expect(WssAgent::Configure['product']).to eq('Test product')
+    end
+  end
+
+  describe '.product_version' do
+    before do
+      allow(WssAgent::Configure).to receive(:current_path)
+                                     .and_return(File.join(File.expand_path('../..', __FILE__), 'fixtures/wss_agent.yml'))
+    end
+
+    it 'should be "1.0.1"' do
+      expect(WssAgent::Configure['product_version']).to eq('1.0.1')
+    end
+  end
+end

data/spec/wss_agent/specifications_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe WssAgent::Specifications, vcr: true do
+  before do
+    allow(WssAgent::Configure).to receive_messages(token: 'xxxxxx')
+  end
+
+  let(:gem_list) {
+    [
+      {
+        'groupId' => 'bacon',
+			  'artifactId' => 'bacon-1.2.0.gem',
+			  'version' => '1.2.0',
+        'sha1' => 'xxxxxxxxxxxxxxxxxxxxxxx',
+        'optional' => '',
+        'children' => '',
+        'exclusions' => ''
+      }
+    ]
+  }
+
+  describe '.check_policies' do
+    let(:success_response) {
+      WssAgent::ResponsePolicies.new(
+        Faraday::Response.new(
+        body:
+          "{\"envelopeVersion\":\"2.1.0\",\"status\":1,\"message\":\"ok\",\"data\":\"{\\\"organization\\\":\\\"TestParallel588\\\",\\\"existingProjects\\\":{\\\"TestProjectUbuntu\\\":{\\\"children\\\":[]}},\\\"newProjects\\\":{},\\\"projectNewResources\\\":{\\\"TestProjectUbuntu\\\":[]}}\"}",
+        status: 200))
+    }
+
+    it 'should check policies' do
+      Timecop.freeze(Time.now) do
+        allow_any_instance_of(WssAgent::Client).to receive(:check_policies)
+                                                    .and_return(success_response)
+
+        allow(WssAgent::Specifications).to receive(:list).and_return(gem_list)
+        expect(capture(:stdout) {WssAgent::Specifications.check_policies}).to eq("All dependencies conform with open source policies\n")
+      end
+    end
+  end
+
+  describe '.update' do
+    let(:wss_client) { WssAgent::Client.new }
+    let(:success_response) {
+      WssAgent::ResponseInventory.new(
+        Faraday::Response.new(
+        body:
+          "{\"envelopeVersion\":\"2.1.0\",\"status\":1,\"message\":\"ok\",\"data\":\"{\\\"organization\\\":\\\"Tom Test\\\",\\\"updatedProjects\\\":[],\\\"createdProjects\\\":[]}\"}",
+        status: 200))
+    }
+    let(:policy_success_response) {
+      WssAgent::ResponsePolicies.new(
+        Faraday::Response.new(
+        body:
+          "{\"envelopeVersion\":\"2.1.0\",\"status\":1,\"message\":\"ok\",\"data\":\"{\\\"organization\\\":\\\"TestParallel588\\\",\\\"existingProjects\\\":{\\\"TestProjectUbuntu\\\":{\\\"children\\\":[]}},\\\"newProjects\\\":{},\\\"projectNewResources\\\":{\\\"TestProjectUbuntu\\\":[]}}\"}",
+        status: 200))
+    }
+
+    it 'should update list gems on server' do
+      Timecop.freeze(Time.now) do
+        allow_any_instance_of(WssAgent::Client).to receive(:update)
+                                                    .and_return(success_response)
+        allow(WssAgent::Specifications).to receive(:list).and_return(gem_list)
+        expect(WssAgent::Specifications.update).to be true
+      end
+    end
+
+    context 'when check_policies is true' do
+
+      before {
+        allow(WssAgent::Client).to receive(:new).and_return(wss_client)
+        allow(WssAgent::Configure).to receive(:current)
+                                       .and_return(WssAgent::Configure.default.merge({'check_policies' => true}))
+      }
+      context 'and check policies return a violation' do
+        it 'should not update inventory' do
+          allow(policy_success_response).to receive(:policy_violations?).and_return(true)
+          expect(wss_client).to receive(:check_policies).and_return(policy_success_response)
+          expect(wss_client).to_not receive(:update)
+
+          expect(WssAgent::Specifications.update).to be false
+        end
+      end
+
+      context 'and check policies returns without a violation' do
+        it 'should update inventory' do
+          allow(WssAgent::Specifications).to receive(:list).and_return(gem_list)
+          allow(policy_success_response).to receive(:policy_violations?).and_return(false)
+          expect(wss_client).to receive(:check_policies).and_return(policy_success_response)
+          expect(wss_client).to receive(:update).and_return(success_response)
+
+          expect(WssAgent::Specifications.update).to be true
+        end
+      end
+    end
+
+    context 'when check_policies is false' do
+      before {
+        allow(WssAgent::Client).to receive(:new).and_return(wss_client)
+        allow(WssAgent::Configure).to receive(:current)
+                                       .and_return(WssAgent::Configure.default.merge({'check_policies' => false}))
+      }
+      it 'should update inventory' do
+        allow(WssAgent::Specifications).to receive(:list).and_return(gem_list)
+
+        expect(wss_client).to_not receive(:check_policies)
+        expect(wss_client).to receive(:update).and_return(success_response)
+
+        expect(WssAgent::Specifications.update).to be true
+      end
+    end
+  end
+
+  describe '.list' do
+    it 'should build list gems'do
+      allow_any_instance_of(WssAgent::GemSha1).to receive(:sha1).and_return("85b19b68a33f1dc0e147ff08bad66f7cfc52de36")
+
+      load_specs = double(specs: Bundler::SpecSet.new([Gem::Specification.new('bacon', '1.2.0')]))
+      allow(Bundler).to receive(:load).and_return(load_specs)
+      expect(WssAgent::Specifications.list).to eq([{"groupId"=>"bacon",
+                                                    "artifactId"=>"bacon-1.2.0.gem",
+                                                    "version"=>"1.2.0",
+                                                    "sha1"=>"85b19b68a33f1dc0e147ff08bad66f7cfc52de36",
+                                                    "optional"=>false,
+                                                    "children"=>[], "exclusions"=>[]}])
+    end
+  end
+
+  describe '.specs' do
+    it 'load bundle spec' do
+      specs_double = double
+      expect(specs_double).to receive(:specs).and_return([])
+      expect(Bundler).to receive(:load).and_return(specs_double)
+      WssAgent::Specifications.specs
+    end
+  end
+end

data/wss_agent.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wss_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wss_agent"
+  spec.version       = WssAgent::VERSION
+  spec.authors       = ["Maxim Pechnikov"]
+  spec.email         = ["parallel588@gmail.com"]
+  spec.summary       = %q{White Source agent.}
+  spec.description   = %q{White Source agent to sync gems}
+  spec.homepage      = "https://github.com/whitesource/ruby-plugin"
+  spec.license       = "Apache License 2.0"
+
+  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.executables   = %w(wss_agent)
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", '~> 0.10', '>= 0.10.1'
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+  spec.add_development_dependency 'webmock', '~> 1.20', '>= 1.20.4'
+  spec.add_development_dependency 'timecop', '~> 0.7', '>= 0.7.1'
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
+
+  spec.add_dependency 'thor', '~> 0.19', '>= 0.19.1'
+  spec.add_dependency 'yell', '~> 2.0', '>= 2.0.5'
+  spec.add_dependency 'excon', '~> 0.42.1'
+  spec.add_dependency 'faraday', '~> 0.9', '>= 0.9.1'
+  spec.add_dependency 'faraday_middleware', '~> 0.9', '>= 0.9.1'
+  spec.add_dependency 'awesome_print', '~> 1.6', '>= 1.6.0'
+  spec.add_dependency 'oj', '~> 2.11', '>= 2.11.2'
+end