Add support for virtualization resource #1803

tkak · 2017-05-11T08:54:08Z

This PR adds support for virtualization resource to detect the virtualization platform. (#1005)

Examples:

case virtualization[:system]
when 'docker'
  describe ...
    ...
  end
when 'vbox'
  describe ...
    ...
  end
end

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

chris-rock

@tkak This is a great addition. Thank you @tkak Can you add documentation to this PR as well? The docs files are located in https://github.com/chef/inspec/tree/master/docs/resources

chris-rock · 2017-05-11T18:05:37Z

lib/resources/virtualization.rb

+      end
+    end
+
+    def [](name)


I think we should use role, system and systems as proper methods, since this is more similar to other resources

Since you have proper methods defined below around like 45/46, can we remove this method now?

tkak · 2017-05-15T01:37:56Z

@chris-rock Thank you for your feedback! I've fixed my PR.

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

adamleff

@tkak thank you so much for your contribution! This appears to be your first time contributing to InSpec as well, so welcome to the community!

I left some feedback that I think will tidy up this new resource and make it easier to understand, add unit tests, etc. Please let me know what you think and how we can help.

Again, thanks again for your contribution!

adamleff · 2017-05-16T02:20:31Z

docs/resources/virtualization.md.erb

+### Test for Docker
+
+    describe virtualization.system do
+      it { should eq 'docker' }


I'd recommend using its here like the example below if not just to be consistent and to ensure the user gets good CLI formatter output. Otherwise, it will say something like "expected docker to == vbox" rather than being clear that the virtualization resource is the item under test.

adamleff · 2017-05-16T02:20:44Z

docs/resources/virtualization.md.erb

+### Detect the virtualization platform
+
+    if virtualization.system == 'vbox'
+      describe package('name')do


Missing a space between ) and do

adamleff · 2017-05-16T02:21:49Z

lib/resources/virtualization.rb

+      end
+    end
+
+    def [](name)


Since you have proper methods defined below around like 45/46, can we remove this method now?

adamleff · 2017-05-16T02:24:15Z

lib/resources/virtualization.rb

+    end
+
+    def collect_data_linux # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      virtualization = Hashie::Mash.new unless virtualization


virtualization appears to be a local variable in this method, is that true? If so, I'm unsure when the unless would ever get hit.

adamleff · 2017-05-16T02:25:52Z

lib/resources/virtualization.rb

+    end
+
+    def collect_data_linux # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      virtualization = Hashie::Mash.new unless virtualization


Since collect_data_linux is used by each of the three defined accessor methods, it could be called multiple times in a single test (i.e. the user had multiple its statements). Should we cache the data in an instance variable and then return it if it's defined? That would eliminate multiple runs through this method.

adamleff · 2017-05-16T02:33:32Z

lib/resources/virtualization.rb

+      inspec.command('nova').exist?
+    end
+
+    def collect_data_linux # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize


Wow, one heck of a method!

My main concern is that it tests for EVERY virtualization possibility, even if one has already matched. For example, if we detect the host is a Xen host, we'll still test for vbox, openstack, etc.

I wonder if it would make more sense to break apart each of the detections into smaller methods that return true if it matched, false if it didn't... example:

def detect_xen return false unless inspec.file('/proc/xen').exist? @virtualization_data[:system] = 'xen' # etc... true end

Then collect_data_linux could be written like so:

def collect_data_linux # cache data in an instance var to avoid doing multiple detections for a single test @virtualization_data ||= Hashie::Mash.new return unless @virtualization_data.empty? # each detect method will return true if it matched and was successfully # able to populate @virtualization_data with stuff. return if detect_xen return if detect_openstack return if detect_foo end

I think this would make the code a bit more readable/manageable, and will also make it easier to test with each system detection being its own method.

What do you think, @tkak?

@adamleff : I agree with you. I referred the ohai code. I will try to fix the method to be smaller. Thank you for your review!

@tkak ah ha! That makes sense. I think the ohai implementation could be improved too, but when running in InSpec against a remote system, it's even more critical to address this so we don't remotely check file status more than we need to, etc.

Looking forward to your update!

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

tkak · 2017-05-20T13:37:30Z

@adamleff Thank you for your review. I made some changes. Would you be able to check them?

adamleff

@tkak thanks for your patience! Last week for ChefConf for us, so we're still catching up.

I think this is super-close. I have one comment/question/suggestion about @virtualization_data[:systems] and I think that should do it!

adamleff · 2017-05-31T20:16:03Z

test/integration/default/virtualization_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+if ENV['DOCKER']


We could simplify this to:

if ENV['DOCKER'] && os.linux # rest of code here end

... and eliminate one indentation level. Not critical to fix here, just something for the future :)

adamleff · 2017-05-31T20:17:55Z

lib/resources/virtualization.rb

+      # cache data in an instance var to avoid doing multiple detections for a single test
+      @virtualization_data ||= Hashie::Mash.new
+      return unless @virtualization_data.empty?
+      @virtualization_data[:systems] ||= Hashie::Mash.new


In the original Ohai implementation, I think the @virtualization_data[:systems] hash was intended to collect all the virtualization data in case a host fell into more than one category. I don't think that's the case, and this likely will confuse users. Can I suggest that we remove this and all entries in this Hash? I think the primary use cases here are best served with the system and role keys that exist at the top-level. What do you think?

@adamleff OK, I'll remove @virtualization_data[:systems] hash. :)

chris-rock · 2017-06-01T03:13:13Z

lib/resources/virtualization.rb

+        it { should eq 'guest' }
+      end
+
+      if virtualization.system == 'docker'


I would prefer to have a control block with only_if here:

control 'test' do describe file('/var/tmp/foo') do it { should be_file } end only_if { virtualization.system == 'docker' } end

@chris-rock @tkak Thanks this closes a long standing request of mine when we started developing the os profiles. Great work! :) 👍

Agree, it is also a great way to show an example of good use of only_if as it is intended. Can't wait to start using this resource in the OS security profiles.

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

adamleff · 2017-06-05T12:17:27Z

@tkak well done! This is a great addition. Thanks for working with us to make this PR great.

adamleff

💯

NOTE TO NEXT APPROVER: this should be squashed via GitHub UI instead of merged, please.

arlimus

Awesome contribution, thank you so much @tkak !! 😄

Kudos @adamleff and @chris-rock for your reviews

* Add support for virtualization resource Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com> * Add some methods and documentation Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com> * Refactor collect_data_linux method Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com> * Remove unnecessary hash from virtualization resource and update examples Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

Add support for virtualization resource

89f4e57

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

tkak force-pushed the add-virtualization branch from 576a36f to 89f4e57 Compare May 11, 2017 08:58

chris-rock reviewed May 11, 2017

View reviewed changes

tkak force-pushed the add-virtualization branch 4 times, most recently from d441b33 to f031e08 Compare May 15, 2017 02:25

Add some methods and documentation

ecfb92f

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

tkak force-pushed the add-virtualization branch from f031e08 to ecfb92f Compare May 15, 2017 03:47

adamleff suggested changes May 16, 2017

View reviewed changes

adamleff added the Type: New Feature Adds new functionality label May 16, 2017

tkak force-pushed the add-virtualization branch 4 times, most recently from db421fe to 04d6b5f Compare May 19, 2017 01:47

tkak changed the title ~~Add support for virtualization resource~~ WIP: Add support for virtualization resource May 19, 2017

tkak force-pushed the add-virtualization branch 2 times, most recently from 98e2212 to b96543c Compare May 20, 2017 13:01

Refactor collect_data_linux method

04d29bf

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

tkak force-pushed the add-virtualization branch from b96543c to 04d29bf Compare May 20, 2017 13:18

tkak changed the title ~~WIP: Add support for virtualization resource~~ Add support for virtualization resource May 20, 2017

adamleff suggested changes May 31, 2017

View reviewed changes

chris-rock reviewed Jun 1, 2017

View reviewed changes

tkak force-pushed the add-virtualization branch from 84a918d to 41fb075 Compare June 5, 2017 08:12

Remove unnecessary hash from virtualization resource and update examples

6756624

Signed-off-by: Takaaki Furukawa <takaaki.frkw@gmail.com>

tkak force-pushed the add-virtualization branch from 41fb075 to 6756624 Compare June 5, 2017 08:28

adamleff approved these changes Jun 5, 2017

View reviewed changes

adamleff requested review from arlimus and chris-rock June 5, 2017 12:18

arlimus approved these changes Jun 7, 2017

View reviewed changes

arlimus merged commit 4f34e3e into inspec:master Jun 7, 2017

tkak deleted the add-virtualization branch July 25, 2017 07:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for virtualization resource #1803

Add support for virtualization resource #1803

tkak commented May 11, 2017

chris-rock left a comment

chris-rock May 11, 2017

adamleff May 16, 2017

tkak commented May 15, 2017

adamleff left a comment

adamleff May 16, 2017

adamleff May 16, 2017

adamleff May 16, 2017

adamleff May 16, 2017

adamleff May 16, 2017

adamleff May 16, 2017 •

edited

tkak May 17, 2017

adamleff May 18, 2017

tkak commented May 20, 2017

adamleff left a comment

adamleff May 31, 2017

adamleff May 31, 2017

tkak Jun 5, 2017

chris-rock Jun 1, 2017

aaronlippold Jun 3, 2017

adamleff commented Jun 5, 2017

adamleff left a comment

arlimus left a comment

Add support for virtualization resource #1803

Add support for virtualization resource #1803

Conversation

tkak commented May 11, 2017

chris-rock left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkak commented May 15, 2017

adamleff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamleff May 16, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkak commented May 20, 2017

adamleff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamleff commented Jun 5, 2017

adamleff left a comment

Choose a reason for hiding this comment

arlimus left a comment

Choose a reason for hiding this comment

adamleff May 16, 2017 •

edited