Add tags to resource group

[rmoles]

Description

• Adds tags and ids as methods for azurerm_resource_group
• Change inspec reporter to cli
• Add pry-byebug to Gemfile
• Add documentation for tags and ids
• fix terraform log profile issue

Please describe what this change achieves. Ensure you have read the Contributing to InSpec document before submitting.

Issues Resolved

Fixes #236

Check List

• 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

[skpaterson]

Thanks @rmoles !

[rrey]

Isn't it supposed to be: The ids property ...

[rmoles]

good catch I'll add a follow-up PR

[rrey]

Isn't it supposed to be: The tags property ... ?
And from the error I get using v.1.13.0:

  ×  main: Resource Groups with name == "azrgr-app0-01" (1 failed)
     ✔  Resource Groups with name == "azrgr-app0-01" is expected to exist
     ×  Resource Groups with name == "azrgr-app0-01" tags is expected to include "{ApplicationCode=\"app0\"}"
     expected [{"ApplicationCode" => "app0", "ApplicationName" => "app0", "Branch" => "PARIS", "Environment" => "d", "Exploitation" => "BOOST", "SecurityLevel" => "Standard"}] to include "{ApplicationCode=\"app0\"}"
     Diff:
     @@ -1,2 +1,7 @@
     -["{ApplicationCode=\"app0\"}"]
     +[{"ApplicationCode"=>"app0",
     +  "ApplicationName"=>"app0",
     +  "Branch"=>"PARIS",
     +  "Environment"=>"d",
     +  "Exploitation"=>"BOOST",
     +  "SecurityLevel"=>"Standard"}]

Profile: Azure Resource Pack (inspec-azure)
Version: 1.13.0

it not a list of all tags, it is a list with a single item containing a map representing all tags.

My test code was:

     its('tags') { should include '{ApplicationCode="app0"}' }

[rmoles]

Didn't pick this up when testing. Apologies. I'll re-visit this.

[rmoles]

@rrey Actually looking at your test I think the issue is the quotes surrounding the hash you are checking for. This should work:

    its('tags') { should include({ApplicationCode="app0"}) }

[rrey]

@rmoles I have a syntax error with your example, error related to "=>" expected instead of the equal sign.
Even with this fixed I get an error:

 ×  main: Resource Groups with name == "azrgr-app0-01" (1 failed)
     ✔  Resource Groups with name == "azrgr-app0-01" is expected to exist
     ×  Resource Groups with name == "azrgr-app0-01" tags
     uninitialized constant #<Class:#<Inspec::ControlEvalContext:0x00007fe9c3ef03d0>>::ApplicationCode


Profile: Azure Resource Pack (inspec-azure)
Version: 1.13.0
Target:  azure://2a8ae5d7-02ef-4f90-8704-20aa8b8bdf87

test code:

    its('tags') { should include({ApplicationCode=>"app0"}) }

[rmoles]

Ah need to stop context switching on this. Think it's still a formatting error:

    its('tags') { should include({"ApplicationCode"=>"app0"}) }

I've tested this:

  describe azurerm_resource_groups do
    it           { should exist }
    its('names') { should include(resource_group) }
    its('tags')  { should include({"CreatedBy"=>"rmoles"}) }
  end

output:

  ✔  azurerm_resource_groups: Resource Groups
     ✔  Resource Groups is expected to exist
     ✔  Resource Groups names is expected to include "Inspec-Azure-rmoles"
     ✔  Resource Groups tags is expected to include {"CreatedBy" => "rmoles"}

Also tested with the where included:

  describe azurerm_resource_groups.where(name: 'Inspec-Azure-rmoles') do
    it           { should exist }
    its('tags')  { should include({"CreatedBy"=>"rmoles"}) }
  end

[rrey]

@rmoles how many tags do you have on the resource ?

Edit: It works if I have only one tag on the resource, but I'm using include on a resource with multiple tags.

[rmoles]

Thanks for pointing that out. This was the reason I wasn't able to replicate the issue.
The issue is down to the way the Inspec FilterTable returns the tags as a Hash within an Array.
There are two possible solutions to this problem.

1. check for the full hash.

its('tags')  { should include({"CreatedBy"=>"rmoles", "blah"=."blah"....}) }

2. call the .first on the tags method

    its('tags.first')  { should include("CreatedBy"=>"rmoles") }
    its('tags.first')  { should include("tester"=>"test") }

output:

  ✔  azurerm_resource_groups: Resource Groups with name == "Inspec-Azure-rmoles"
     ✔  Resource Groups with name == "Inspec-Azure-rmoles" is expected to exist
     ✔  Resource Groups with name == "Inspec-Azure-rmoles" tags.first is expected to include {"CreatedBy" => "rmoles"}
     ✔  Resource Groups with name == "Inspec-Azure-rmoles" tags.first is expected to include {"tester" => "test"}

[rrey]

@rmoles
ok, the full hash is working and is fine for me.
Thanks for your time on this !