Adds Chef/Inspec User-Agent to Azure API calls #120

ghost · 2018-08-20T16:43:35Z

Description

Adds Chef Open Source UUID as a header on all API calls to Azure, to measure usage/impact.

Check List

[N/A] New functionality includes tests
All tests pass
rake lint passes
All commits have been signed-off for the Developer Certificate of Origin. See https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco

This change replaces our connection logic with the InSpec backend (backed by Train) to handle connections. By doing so, we can now support using a credentials file, MSI connector as well as shell vars. I'm also adding another terraform target to start up a linux virtual machine with MSI enabled. You will need to add that MSI account with the contributor role to your subscription for MSI to work against the REST API. To start up the MSI vm: `rake msi_vm tf:apply` You will need to add a public ssh key to your `.envrc` file as well. An example is included in `.envrc-example`. Note: If you run integration tests while you have the MSI vm running tests will fail. The tests were written with the assumption that there would be only two vms. Signed-off-by: David McCown <dmccown@chef.io>

Signed-off-by: David McCown <dmccown@chef.io>

This change replaces our connection logic with the InSpec backend (backed by Train) to handle connections. By doing so, we can now support using a credentials file, MSI connector as well as shell vars. I'm also adding another terraform target to start up a linux virtual machine with MSI enabled. You will need to add that MSI account with the contributor role to your subscription for MSI to work against the REST API. To start up the MSI vm: `rake msi_vm tf:apply` You will need to add a public ssh key to your `.envrc` file as well. An example is included in `.envrc-example`. Note: If you run integration tests while you have the MSI vm running tests will fail. The tests were written with the assumption that there would be only two vms. Signed-off-by: David McCown <dmccown@chef.io>

Signed-off-by: David McCown <dmccown@chef.io>

* Replaces all default `client` names with `management` to indicate what route the resource is interacting with Co-authored-by: Ruairi Fennell <rfennell@chef.io> Co-authored-by: David McCown <dmccown@chef.io> Signed-off-by: David McCown <dmccown@chef.io>

…b.com/inspec/inspec-azure into dmccown/replace-connection-with-train

This change replaces our connection logic with the InSpec backend (backed by Train) to handle connections. By doing so, we can now support using a credentials file, MSI connector as well as shell vars. I'm also adding another terraform target to start up a linux virtual machine with MSI enabled. You will need to add that MSI account with the contributor role to your subscription for MSI to work against the REST API. To start up the MSI vm: `rake msi_vm tf:apply` You will need to add a public ssh key to your `.envrc` file as well. An example is included in `.envrc-example`. Note: If you run integration tests while you have the MSI vm running tests will fail. The tests were written with the assumption that there would be only two vms. Signed-off-by: David McCown <dmccown@chef.io>

Signed-off-by: David McCown <dmccown@chef.io>

* Replaces all default `client` names with `management` to indicate what route the resource is interacting with Co-authored-by: Ruairi Fennell <rfennell@chef.io> Co-authored-by: David McCown <dmccown@chef.io> Signed-off-by: David McCown <dmccown@chef.io>

Signed-off-by: David McCown <dmccown@chef.io>

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

davymcaleer · 2018-08-20T16:56:55Z

@r-fennell the User Agent should be:
INSPEC_USER_AGENT = 'Chef-Inspec-18d63047-6cdf-4f34-beed-62f01fc73fc2'
No the pid was actually the ProductID, in this case InSpec

ghost · 2018-08-20T19:05:00Z

Should Chef removed completely?

dmccown · 2018-08-20T21:14:16Z

libraries/support/azure/rest.rb

@@ -5,6 +5,10 @@

 module Azure
  class Rest
+    USER_AGENT = 'User-Agent'
+    INSPEC_USER_AGENT = 'Chef-Inspec-pid-18d63047-6cdf-4f34-beed-62f01fc73fc2'
+    private_constant  :USER_AGENT, :INSPEC_USER_AGENT


Strings are already frozen on line 1

inspec-azure/libraries/support/azure/rest.rb

Line 1 in e11b70e

# frozen_string_literal: true

and these vars should be private by default. I don't think you need line 10.

Sorry @r-fennell - re-added Chef above - for clarity just removing the pid string:

INSPEC_USER_AGENT = 'Chef-Inspec-18d63047-6cdf-4f34-beed-62f01fc73fc2'

@dmccown I can't find any documentation indicating default scope of constants is private. I used this and this as reference. Is it a new ruby version change?

I was wrong in assuming scope, thanks for pointing that out.

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

bmoore-msft · 2018-08-21T16:10:31Z

libraries/support/azure/rest.rb

@@ -5,6 +5,9 @@

 module Azure
  class Rest
+    USER_AGENT = 'User-Agent'
+    INSPEC_USER_AGENT = 'Chef-Inspec-18d63047-6cdf-4f34-beed-62f01fc73fc2'


this must be:
INSPEC_USER_AGENT = 'pid-18d63047-6cdf-4f34-beed-62f01fc73fc2'
you can add others if needed

@bmoore-msft "you can add others if needed" so we should generate GUIDs for our specific subproducts rather than tagging them in the agent?

We need exactly one string in the "pid-GUID" format... if there is other info you want to derive from the UA (not related to our tracking) then, you can still add it to the UA, but it will be ignored in the query. That help?

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

ghost · 2018-09-12T21:03:54Z

@trevorghess Sorry it took so long to get back to this. Let me know if anything else needs changed!

russellseymour

👍

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

David McCown and others added 23 commits July 10, 2018 16:26

Fixes error handling.

d2cbcc2

Signed-off-by: David McCown <dmccown@chef.io>

Merge conflicts

1f86499

Replaces rest client credentials with concrete client

eb48bfa

Fixes error handling.

ce25c9f

Signed-off-by: David McCown <dmccown@chef.io>

Adds graph client

fab15f1

* Replaces all default `client` names with `management` to indicate what route the resource is interacting with Co-authored-by: Ruairi Fennell <rfennell@chef.io> Co-authored-by: David McCown <dmccown@chef.io> Signed-off-by: David McCown <dmccown@chef.io>

Only add resource forward slash where required

6d1c335

Merge branch 'dmccown/replace-connection-with-train' of https://githu…

4c6a4de

…b.com/inspec/inspec-azure into dmccown/replace-connection-with-train

Fixes error handling.

b1e98fd

Signed-off-by: David McCown <dmccown@chef.io>

Adds graph client

bea77c1

* Replaces all default `client` names with `management` to indicate what route the resource is interacting with Co-authored-by: Ruairi Fennell <rfennell@chef.io> Co-authored-by: David McCown <dmccown@chef.io> Signed-off-by: David McCown <dmccown@chef.io>

Adds docs and option for msi

405495e

Signed-off-by: David McCown <dmccown@chef.io>

Fixes msi option

8eed38b

Signed-off-by: David McCown <dmccown@chef.io>

Merge master in

8ee6bf6

Fix client naming

a60df62

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

Checkstyle

a731fec

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

Skip Graph controls until MSI support is added

713289d

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

Adds useragent

591f329

Adds User-Agent

e11b70e

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

ghost requested review from dmccown, russellseymour and davymcaleer August 20, 2018 16:43

dmccown reviewed Aug 20, 2018

View reviewed changes

Update User Agent

b711e0f

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

bmoore-msft suggested changes Aug 21, 2018

View reviewed changes

Merge master in, update User Agent

c2c2bb2

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

ghost changed the base branch from dmccown/replace-connection-with-train to master September 12, 2018 20:59

Remove .DS_Store

ba0f78b

russellseymour approved these changes Sep 18, 2018

View reviewed changes

Ruairi Fennell added 2 commits September 18, 2018 10:56

Merge branch 'master' into Inspec-User-Agent

b1bcc58

Sign

52c3523

Signed-off-by: Ruairi Fennell <rfennell@chef.io>

ghost merged commit 25cb68f into master Sep 18, 2018

ghost deleted the Inspec-User-Agent branch September 18, 2018 10:03

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Chef/Inspec User-Agent to Azure API calls #120

Adds Chef/Inspec User-Agent to Azure API calls #120

ghost commented Aug 20, 2018

davymcaleer commented Aug 20, 2018 •

edited

Loading

ghost commented Aug 20, 2018

dmccown Aug 20, 2018

davymcaleer Aug 21, 2018

ghost Aug 21, 2018

dmccown Aug 21, 2018

bmoore-msft Aug 21, 2018

trevorghess Aug 21, 2018

bmoore-msft Aug 23, 2018

ghost commented Sep 12, 2018

russellseymour left a comment

Adds Chef/Inspec User-Agent to Azure API calls #120

Adds Chef/Inspec User-Agent to Azure API calls #120

Conversation

ghost commented Aug 20, 2018

Description

Check List

davymcaleer commented Aug 20, 2018 • edited Loading

ghost commented Aug 20, 2018

dmccown Aug 20, 2018

Choose a reason for hiding this comment

davymcaleer Aug 21, 2018

Choose a reason for hiding this comment

ghost Aug 21, 2018

Choose a reason for hiding this comment

dmccown Aug 21, 2018

Choose a reason for hiding this comment

bmoore-msft Aug 21, 2018

Choose a reason for hiding this comment

trevorghess Aug 21, 2018

Choose a reason for hiding this comment

bmoore-msft Aug 23, 2018

Choose a reason for hiding this comment

ghost commented Sep 12, 2018

russellseymour left a comment

Choose a reason for hiding this comment

davymcaleer commented Aug 20, 2018 •

edited

Loading