Release machine_name "fullName" property, XCVersion and Simulators un…

…it tests (#28)

* first commit plistbuddy

* all recipe/plist in macos

* extract plistbuddy to resource

* Straighten out unit tests

- Correctly include modules
- Correctly setup spec_helper
- Correct unit test / respec setup

* first passing test

* add more data type tests

* Most data types passing

- Boolean values are working
- Array and data type values are not
- PlistBuddy "commands" (add, print, etc.) are passing

* More testing

- Skip Array and Dict types as their implementation will be more
complicated
- Add test for float type
- Put the correct type in the test description
- Cookstyle changes

* PlistBuddy and testing update

- Add separate test cookbook for PlistBuddy resource
- Add kitchen.yml for the above purpose
- Modify and update plistbuddy resource/helpers

* remove extra newline

* add metadata file

* edit metadata; add Berksfile

* move Berksfile to correct location

* add testing requirements for berks vendor

* move kitchen file

* Converge passing in test cookbook

- Opportunistic cleanup of xcode test
- some temp debugging info in resource definition
- Rename name_property to command so as to not override action

* Itempotence

- Removed 'bool' prefix from boolean types, as that was somehow causing
issues
- Changed name_property to the path and removed that property
- Use actual actions in the resource for the PlistBuddy commands

* Fix false positive?

- Not sure how the previous test was passing previously, but I adjusted
the boolean value for the BazEntry test so that the signature input
matches the output

* Add logic for adding a value

- The data type should only be used when adding a value to a plist.
Otherwise, we don't need to use the data type

* remove debugging; fix smoke tests

* remove .kitchen.yml

* bump version to 0.8.5

* unskip ChefSpec tests - they're passing

* mark args_formatter as private method

* Feature/macos user (#14)

* first commit add_user recipe

* Testing Refactor & macos_user resource

- Create new testing cookbook that contains tests for both plistbuddy
and macos_user resources. The hope here is to have a single testing
cookbook that contains multiple suites and suite testing variations
- Create new macos_user resource - contains single boolean 'true'
settings for autologin and admin user. Still work to be done for admin
user and all steps that need to be taken to acheive the task.

* fix method call

* fix another method call

* user native ruby File class and not overriden

* fix some minor issues with resource; add kcpassword file

* Add OG Ruby kcpassword file helper module

* slightly different approach for Kcpassword module

* passing test

* Fix up kcpassword library module, smoke tests

- Modify Kcpassword helper module to use a method for
magic bits. This isn't ideal, but it works for now
- Update smoke tests so that john_jr's group ID is 20. This
may not be correct, but setting as 20 until it is further
investigated

* opportunistic refactor of keep_awake recipe

* Refactor testing cookbook layout

- Consolodate testing suites into single default suite
- Add tests for keep_awake recipe
- Use more common examples to test PlistBuddy resource

* move xcode test to test cookbook

* Opportunistic bug fix for plistbuddy resource

- Previously, the plistbuddy resource did not allow
any keys with spaces unless they were used in the value itself.
Now, you can use keys with spaces in the value property
without needing to double-quote it
- Also, fix the PlistBuddy executable string to be correct

* revert kcpassword.rb helper to a671164

* fix incorrect PlistBuddy data type name

* Fix kcpassword.rb and update plistbuddy UTs

* Extract disabling screen saver to plistbuddy

- Also, skip Xcode test temporarily

* PlistBuddy idempotence

- Remove systemsetup and pmset resource calls in keep_awake
until they are made idempotent

* update test and plist name

* Implement binary plist conversion

- Changes to binary plists via PlistBuddy must be converted back
to binary since the change implicitly converts the file to xml.
This change contains logic to convert back to binary if the file is
detected to be binary in the first place.

* attempts at idempotence using chef helper methods

* early commit to get it on the remote

* implement logic for plist return type to ruby data type

* Add floating type value support

A wild FAILING TEST appeared!
...
HANKO used TDD!
It's super effective!

* move function

* real idempotence!

* passing all unit tests

* update test cookbook name

* update new_users integration tests

* systemsetup idempotence

* all smoke and unit tests passing

* quick fix for timezone bug

* remove kcpassword file as it is no longer needed

* update path for test cookbook to be default repo name

* Rename keep_awake_spec.rb to keep_awake_test.rb

* Rename preferences_spec.rb to preferences_test.rb

* Rename new_users_spec.rb to new_users_test.rb

* fix typo

* Use relative path for macos cookbook source

* Improve readability of relative path for macos cookbook source

* Bump version

* Addressing changes in Pull Request #14

- Fix bug where screensaver was not properly being disabled, update
tests accordingly
- Rename plistbuddy resource to plist, including all related files
and callers
- Rename kcpassword helper to macos_user to match helper -> resource
convention; fix top level namespace to be MacOS
- Correctly name recipe unit tests
- Implement plist resource into disable_software_updates.rb recipe
- Add disable_software_updates.rb recipe to default kitchen suite and
appropriate smoke tests
- Remove relatively useless logic in systemsetup value property coercion

* Implement binary plist conversion

* Fix unit test and apply the Law of Demeter

* update helper pattern to match current standard; include everywhere

* remove helper reference in Xcode resource

* bump version

* update Xcode attribute to latest

* extract xcode smoke tests to a different suite

* update xcversion path for simulators test

* update namespace again

* refactor XcodeHelper modules in XCVersion, Xcode, and XCVersion modules

updated methods to simplify site calls in resource

* updated method calls for new modules

* bump version

* extract xcversion module to separate library file

* add missing macos module

* include parent module macos instead of child for xcode and xcversion

* update available_simulator_versions to new method

* bump version

* add platform-specific smoke test for xcode

* add xcode test recipe

* update kitchen with xcode suite

* refactor simulator method to call it's own available list of simulators

* use new simulator method to find highest available version

* move xcode prep work into the setup action

* clear kitchen customizations

* lazily evalutate ios simulator property

* move lazy evaluation to simulator action in xcode resource

* revert lazy execution

* warn and retry if simulator list is empty

* restore spacing

* more whitespace

* refactor highest_semantic_simulator method into class, smaller methods

* implement simulator class

* add more xcversion command methods

* implement xcversion command methods

* implement command methods correctly

* add list methods for xcversion

* implement xcversion list methods

* implement install xcode correctly

* reorder methods

* add method to list installed xcodes

* use more descriptive name for 'command' method

* move where the space lives

* implement installed xcodes command

* implement install xcodes correctly

* disable downloads prior to disabling software update check

* Renamed name to device_name

* Change name.rb to machine_name.rb to be similar with the apex
automation cookbook. Instances of name are also all changed to
machine_name.

* Add new test recipe and smoke test for machine_name.

* add disable-swu test suite

* Bump up cookbook version numbers.

* update kitchen test suite order, remove standalone swu testing

* add sleep for El Capitan platform to avoid race condition

this occurs when integrated with the macos-user test recipe

* Improve README/Documentation (#23)

* implement build definition badge and minor tweaks

* Add descriptions and attribute lists for recipes

* Remove 'description' label from recipe names

* Bump version, add documentation dir

* Fix up the last commit

* Separate 10.12 and 10.13 build status

* Add table for build status

* Add plist resource documentation

* Add Xcode documentation

* bump version

* Fix for enhancement macos_user needs fullName property #25

1. Added fullname property to macos_user resource
2. Modified test recipe for user johnny to have full name
3. Added smoke test to test for RealName using dscl command

Ideally we should have a custom inspec resource.

* Fix extra new lines

* add spec tests for xcversion module

* add spec test for Simulator

* update Simulator spec tests

* Fix code based on suggestions in PR #26

1. Hide usage of escape characters in multi-word fullnames in macos_user resource
2. Pass an array of strings to command method for auto escape

* Remove escape character

* bump version

* Incorporate Eric's changes in PR 28 regarding macos_user resource and fullname

* Make sure it passes cookstyle

metadata.rb

@@ -5,7 +5,7 @@
 description 'Resources for configuring and provisioning macOS'
 long_description 'Resources for configuring and provisioning macOS'
 chef_version '~> 13.0' if respond_to?(:chef_version)
-version '1.0.0'
+version '1.1.0'
 
 source_url 'https://github.com/Microsoft/macos-cookbook'
 issues_url 'https://github.com/Microsoft/macos-cookbook/issues'

resources/macos_user.rb

@@ -5,6 +5,7 @@
 property :password, String, default: 'password'
 property :autologin, [TrueClass]
 property :admin, [TrueClass]
+property :fullname, String
 
 action_class do
   def user_home
@@ -25,19 +26,28 @@ def sysadminctl
     '/usr/sbin/sysadminctl'
   end
 
-  def admin_user?
+  def user_fullname
+    property_is_set?(:fullname) ? ['-fullName', new_resource.fullname] : ''
+  end
+
+  def admin_user
     if property_is_set?(:admin)
       '-admin'
     else
       ''
     end
   end
+
+  def user_already_exists?
+    users_output = shell_out!('/usr/bin/dscl', '.', '-list', '/users').stdout
+    users_output.split("\n").include?(new_resource.username)
+  end
 end
 
 action :create do
   execute "add user #{new_resource.username}" do
-    command "#{sysadminctl} -addUser #{new_resource.username} -password #{new_resource.password} #{admin_user?}"
-    not_if { ::File.exist? user_home }
+    command [sysadminctl, '-addUser', new_resource.username, *user_fullname, '-password', new_resource.password, admin_user]
+    not_if { ::File.exist?(user_home) && user_already_exists? }
   end
 
   if property_is_set?(:autologin)
@@ -73,6 +83,6 @@ def admin_user?
 
   execute "delete user: #{user}" do
     command "#{sysadminctl} -deleteUser #{new_resource.username}"
-    only_if { "/usr/bin/dscl . -list /users | grep ^#{new_resource.username}$" }
+    only_if { user_already_exists? }
   end
 end

spec/spec_helper.rb

@@ -4,6 +4,7 @@
 require_relative '../libraries/macos_user'
 require_relative '../libraries/plist'
 require_relative '../libraries/xcode'
+require_relative '../libraries/xcversion'
 
 RSpec.configure do |config|
   config.platform = 'mac_os_x'

spec/unit/libraries/xcode_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+include MacOS::Xcode
+
+describe MacOS::Xcode::Simulator do
+  context 'when provided an available list of simulators' do
+    before do
+      allow_any_instance_of(MacOS::Xcode::Simulator).to receive(:available_versions)
+        .and_return(<<-XCVERSION_OUTPUT
+                    Xcode 9.2 (/Applications/Xcode-9.2.app)
+                    iOS 8.1 Simulator (not installed)
+                    iOS 8.2 Simulator (not installed)
+                    iOS 8.3 Simulator (not installed)
+                    iOS 8.4 Simulator (not installed)
+                    iOS 9.0 Simulator (not installed)
+                    iOS 9.1 Simulator (not installed)
+                    iOS 9.2 Simulator (not installed)
+                    iOS 9.3 Simulator (not installed)
+                    iOS 10.0 Simulator (not installed)
+                    iOS 10.1 Simulator (not installed)
+                    tvOS 9.0 Simulator (not installed)
+                    tvOS 9.1 Simulator (not installed)
+                    tvOS 9.2 Simulator (not installed)
+                    tvOS 10.0 Simulator (not installed)
+                    watchOS 2.0 Simulator (not installed)
+                    watchOS 2.1 Simulator (not installed)
+                    watchOS 2.2 Simulator (not installed)
+                    tvOS 10.1 Simulator (not installed)
+                    iOS 10.2 Simulator (not installed)
+                    watchOS 3.1 Simulator (not installed)
+                    iOS 10.3.1 Simulator (not installed)
+                    watchOS 3.2 Simulator (not installed)
+                    tvOS 10.2 Simulator (not installed)
+                    iOS 11.0 Simulator (not installed)
+                    watchOS 4.0 Simulator (not installed)
+                    tvOS 11.0 Simulator (not installed)
+                    tvOS 11.1 Simulator (not installed)
+                    watchOS 4.1 Simulator (not installed)
+                    iOS 11.1 Simulator (not installed)
+                    XCVERSION_OUTPUT
+                   )
+    end
+    it 'returns the latest semantic version of iOS 11' do
+      s = MacOS::Xcode::Simulator.new('11')
+      expect(s.version).to eq 'iOS 11.1'
+    end
+    it 'returns the latest semantic version of iOS 10' do
+      s = MacOS::Xcode::Simulator.new('10')
+      expect(s.version).to eq 'iOS 10.3.1'
+    end
+    it 'returns the latest semantic version of iOS 9' do
+      s = MacOS::Xcode::Simulator.new('9')
+      expect(s.version).to eq 'iOS 9.3'
+    end
+  end
+end

spec/unit/libraries/xcversion_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+include MacOS::XCVersion
+
+describe MacOS::XCVersion.install_xcode('9.0') do
+  context "when passed '9.0'" do
+    it 'returns the full xcversion install command for Xcode 9.0' do
+      expect(MacOS::XCVersion.install_xcode('9.0'))
+        .to eq "/opt/chef/embedded/bin/xcversion install '9'"
+    end
+  end
+end
+
+describe MacOS::XCVersion.install_xcode('8.3.3') do
+  context "when passed '8.3.3'" do
+    it 'returns the full xcversion install command for Xcode 8.3.3' do
+      expect(MacOS::XCVersion.install_xcode('8.3.3'))
+        .to eq "/opt/chef/embedded/bin/xcversion install '8.3.3'"
+    end
+  end
+end
+
+describe MacOS::XCVersion.install_xcode('8.2') do
+  context "when passed '8.2'" do
+    it 'returns the full xcversion install command for Xcode 8.2' do
+      expect(MacOS::XCVersion.install_xcode('8.2'))
+        .to eq "/opt/chef/embedded/bin/xcversion install '8.2'"
+    end
+  end
+end
+
+describe MacOS::XCVersion.apple_pseudosemantic_version('9.0') do
+  context "when passed '9.0'" do
+    it "returns '9'" do
+      expect(MacOS::XCVersion.apple_pseudosemantic_version('9.0'))
+        .to eq '9'
+    end
+  end
+end
+
+describe MacOS::XCVersion.apple_pseudosemantic_version('8.3.3') do
+  context "when passed '8.3.3'" do
+    it "returns '8.3.3'" do
+      expect(MacOS::XCVersion.apple_pseudosemantic_version('8.3.3'))
+        .to eq '8.3.3'
+    end
+  end
+end
+
+describe MacOS::XCVersion.apple_pseudosemantic_version('8.2') do
+  context "when passed '8.2'" do
+    it "it returns '8.2'" do
+      expect(MacOS::XCVersion.apple_pseudosemantic_version('8.2'))
+        .to eq '8.2'
+    end
+  end
+end

test/cookbooks/macos_test/recipes/new_users.rb

@@ -7,5 +7,6 @@
 
 macos_user 'create non-admin user johnny' do
   username 'johnny'
+  fullname 'Johnny Appleseed'
   password 'yang-yolked-cordon-karate'
 end

test/cookbooks/macos_test/test/smoke/default/new_users_test.rb

@@ -14,4 +14,10 @@
     its('gid') { should eq 20 }
     its('home') { should eq '/Users/johnny' }
   end
+
+  realname_cmd = 'dscl . read /Users/johnny RealName | grep -v RealName | cut -c 2-'
+
+  describe command(realname_cmd) do
+    its('stdout.strip') { should eq 'Johnny Appleseed' }
+  end
 end