Merge pull request #13 from donoghuc/BOLT-519

MikaelSmith · web-flow · commit ad605d88581b · 2018-05-23T09:09:20.000-07:00
(BOLT-519) Set User-Agent header for analytics use
diff --git a/README.md b/README.md
@@ -22,9 +22,10 @@ expected to be at `~/.puppetlabs/token` which is the default location used by
 ### initialization Settings
 
 * `service-url` **[required]** - Base URL for the location of the Orchestrator API service
-* `ca_cert` **[required]** - Path to the CA certificate file needed to verify the SSL connection to the API.
-* `token_path`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`)
+* `cacert` **[required]** - Path to the CA certificate file needed to verify the SSL connection to the API.
+* `token-file`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`)
 * `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file.
+* `User-Agent`- Set `User-Agent` header for HTTP requests. Defaults to `OrchestratorRubyClient/[VERSION]`
 
 ### Example
 
@@ -36,7 +37,7 @@ require 'orchestrator_client'
 
 client = OrchestratorClient.new({
                                 'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
-                                'ca_cert'     => '/path/to/cert'
+                                'cacert'     => '/path/to/cert'
                               })
 
 ## Access endpoints through the client object
diff --git a/lib/orchestrator_client.rb b/lib/orchestrator_client.rb
@@ -35,6 +35,7 @@ def get(location)
     https = create_http(uri)
     req = Net::HTTP::Get.new(uri)
     req['Content-Type'] = "application/json"
+    req['User-Agent'] = @config['User-Agent']
     req.add_field('X-Authentication', @config.token)
     res = https.request(req)
 
@@ -51,6 +52,7 @@ def post(location, body)
 
     req = Net::HTTP::Post.new(uri)
     req['Content-Type'] = "application/json"
+    req['User-Agent'] = @config['User-Agent']
     req.add_field('X-Authentication', @config.token)
     req.body = body.to_json
     res = https.request(req)
diff --git a/lib/orchestrator_client/config.rb b/lib/orchestrator_client/config.rb
@@ -34,6 +34,7 @@ def cacert
   def defaults
     { 'cacert' => cacert,
       'token-file' => File.join(user_root, 'token'),
+      'User-Agent' => "OrchestratorRubyClient/#{OrchestratorClient::VERSION}"
     }
   end
 
diff --git a/spec/unit/command_spec.rb b/spec/unit/command_spec.rb
@@ -32,7 +32,7 @@
 
       stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/deploy").
         with(:body => @deploy_opts.to_json,
-             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 202, :body => response, :headers => {})
 
       expect(@orchestrator.command.deploy(@deploy_opts)).to be_an_instance_of Hash
@@ -45,7 +45,7 @@
 
       stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/task").
         with(:body => @task_opts.to_json,
-             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 202, :body => response, :headers => {})
 
       expect(@orchestrator.command.task(@task_opts)).to be_an_instance_of Hash
@@ -58,7 +58,7 @@
 
       stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/stop").
         with(:body => "{\"job\":\"1\"}",
-             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 202, :body => response, :headers => {})
 
       expect(@orchestrator.command.stop(1)).to be_an_instance_of Hash
diff --git a/spec/unit/jobs_spec.rb b/spec/unit/jobs_spec.rb
@@ -23,7 +23,7 @@
 
     it 'optionally accepts a number to limit results' do
       stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs?limit=1").
-        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 200, :body => response, :headers => {})
 
       expect(@orchestrator.jobs.all(1)).to be_an_instance_of Hash
@@ -33,7 +33,7 @@
       response =  "{\n  \"items\" : [ {\n    \"report\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/report\"\n    },\n    \"name\" : \"58\",\n    \"events\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/events\"\n    },\n    \"state\" : \"failed\",\n    \"nodes\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/nodes\"\n    },\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58\",\n    \"environment\" : {\n      \"name\" : \"production\"\n    },\n    \"options\" : {\n      \"concurrency\" : null,\n      \"noop\" : false,\n      \"trace\" : false,\n      \"debug\" : false,\n      \"scope\" : {\n        \"whole_environment\" : true\n      },\n      \"enforce_environment\" : true,\n      \"environment\" : \"production\",\n      \"evaltrace\" : false,\n      \"target\" : \"whole environment\"\n    },\n    \"timestamp\" : \"2016-09-20T19:01:18Z\",\n    \"owner\" : {\n      \"id\" : \"80f8475c-d8b5-4dfd-b567-3cae4ef7a3a7\",\n      \"login\" : \"tom\"\n    },\n    \"node_count\" : 2\n  } ]\n}"
 
       stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs").
-        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 200, :body => response, :headers => {})
 
       expect(@orchestrator.jobs.all).to be_an_instance_of Hash
@@ -54,7 +54,7 @@
 
     it 'takes a job number and accespts a start number to retrieve latest results' do
       stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events?start=10").
-        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 200, :body => response, :headers => {})
 
       expect(@orchestrator.jobs.events(1,10)).to be_an_instance_of Hash
@@ -63,7 +63,7 @@
       response = "{\n  \"next-events\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events?start=7\"\n  },\n  \"items\" : [ {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"orchestrator.example.lan\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on orchestrator.example.lan ...\",\n    \"id\" : \"1\"\n  }, {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"agent2.puppetlabs.vm\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on agent2.puppetlabs.vm ...\",\n    \"id\" : \"2\"\n  }, {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"agent1.puppetlabs.vm\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on agent1.puppetlabs.vm ...\",\n    \"id\" : \"3\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:34:47Z\",\n    \"details\" : {\n      \"node\" : \"agent1.puppetlabs.vm\",\n      \"detail\" : {\n        \"hash\" : \"20d60265af8bafc0ac1b99c1eb4b8bde411a81a3\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 0,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 171,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/20d60265af8bafc0ac1b99c1eb4b8bde411a81a3\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296882\"\n      }\n    },\n    \"message\" : \"Finished puppet run on agent1.puppetlabs.vm - Success! \",\n    \"id\" : \"4\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:34:47Z\",\n    \"details\" : {\n      \"node\" : \"agent2.puppetlabs.vm\",\n      \"detail\" : {\n        \"hash\" : \"d460f0a513b1e18d43f19867b269cf105772fc41\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 0,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 171,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/d460f0a513b1e18d43f19867b269cf105772fc41\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296882\"\n      }\n    },\n    \"message\" : \"Finished puppet run on agent2.puppetlabs.vm - Success! \",\n    \"id\" : \"5\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:35:26Z\",\n    \"details\" : {\n      \"node\" : \"orchestrator.example.lan\",\n      \"detail\" : {\n        \"hash\" : \"c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 3,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 789,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296883\"\n      }\n    },\n    \"message\" : \"Finished puppet run on orchestrator.example.lan - Success! \",\n    \"id\" : \"6\"\n  } ]\n}"
 
       stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events").
-        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 200, :body => response, :headers => {})
 
       expect(@orchestrator.jobs.events(1)).to be_an_instance_of Hash
diff --git a/spec/unit/orchestrator_client_spec.rb b/spec/unit/orchestrator_client_spec.rb
@@ -37,7 +37,17 @@
   describe "#get" do
     it 'takes an endpoint and parses the response as JSON' do
       stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/endpoint").
-        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => "{}", :headers => {})
+
+      expect(@orchestrator_api.get('endpoint')).to be_an_instance_of Hash
+    end
+
+    it 'updates User-Agent header' do
+      @config['User-Agent'] = 'foo'
+      @orchestrator_api = OrchestratorClient.new(@config)
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/endpoint").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"foo", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 200, :body => "{}", :headers => {})
 
       expect(@orchestrator_api.get('endpoint')).to be_an_instance_of Hash
@@ -48,10 +58,20 @@
     it 'takes an endpoint, endpoint, and parses the response as JSON' do
       stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/endpoint").
         with( :body => "{\"data\":\"atad\"}",
-              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"OrchestratorRubyClient/#{OrchestratorClient::VERSION}", 'X-Authentication'=>'myfaketoken'}).
         to_return(:status => 202, :body => "{}", :headers => {})
 
       expect(@orchestrator_api.post('endpoint',{'data' => 'atad'})).to be_an_instance_of Hash
     end
+
+    it 'updates User-Agent header' do
+      @config['User-Agent'] = 'foo'
+      @orchestrator_api = OrchestratorClient.new(@config)
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/endpoint").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>"foo", 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => "{}", :headers => {})
+
+      expect(@orchestrator_api.get('endpoint')).to be_an_instance_of Hash
+    end
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ def cacert`
`34`	`34`	`def defaults`
`35`	`35`	`{ 'cacert' => cacert,`
`36`	`36`	`'token-file' => File.join(user_root, 'token'),`
	`37`	`+ 'User-Agent' => "OrchestratorRubyClient/#{OrchestratorClient::VERSION}"`
`37`	`38`	`}`
`38`	`39`	`end`
`39`	`40`