Add PlistBuddy Resource #12

americanhanko · 2017-10-27T06:11:40Z

This PR:

Adds a new plistbuddy resource for manipulating property list files on macOS
Adds a test cookbook for PlistBuddy, which demonstrates a solid framework for wrapper-cookbook testing (cd into the cookbook directory and run kitchen test)
Skips currently failing ChefSpec tests

Why

PlistBuddy is a better way of manipulating property lists because:
- It does not adhere to a specific user (like defaults does)
- It is much easier to manipulate and check the state of Plist container types (dicts, arrays)
The current defaults resource is not idempotent
Has significantly better test coverage than defaults

Example Usage in some recipe `preferences.rb`

plistbuddy '/Users/vagrant/Library/Preferences/com.apple.finder.plist' do
  entry 'AppleShowAllFiles'
  value true
end

plistbuddy '/Users/vagrant/Library/Preferences/com.apple.dock.plist' do
  entry 'showMissionControlGestureEnabled'
  value false
end

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

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

- 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

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

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

- 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

- 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

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

msftclas · 2017-10-27T06:11:49Z

All CLA requirements met.

jazaval

I like the idea of the test cookbook, but I think it ought to be scoped to the entire macos cookbook, and contain specific recipes within the kitchen suites.

jazaval · 2017-10-27T17:37:25Z

libraries/plistbuddy.rb

+  end
+end
+
+Chef::Recipe.include(MacOS::PlistBuddyHelpers)


Given some of the method names here are not super specific (args_formatter), maybe the PlistBuddy resource should import these instead?

Not sure what you mean. I probably should've set args_formatter to private, but regardless, that method exists only to add the data type if the Add command is called.

I've set args_formatter to private, which I think makes sense given the usage.

I think extracting the plistbuddy test cookbook to an entire test cookbook is outside the scope of this PR.

jazaval · 2017-10-27T17:38:11Z

libraries/plistbuddy.rb

@@ -0,0 +1,32 @@
+include Chef::Mixin::ShellOut


Don't think you need this.

jazaval · 2017-10-27T17:39:33Z

spec/unit/recipes/xcode_spec.rb

    end

-    it 'converges successfully' do
+    xit 'converges successfully' do


Are we saying that these are not useful?

Eric Hanko added 21 commits October 26, 2017 00:30

first commit plistbuddy

6927637

all recipe/plist in macos

b6cc4f0

extract plistbuddy to resource

ed74b85

Straighten out unit tests

9beca33

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

first passing test

2bca4d5

add more data type tests

b44a023

Most data types passing

21dddd9

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

More testing

70f9d09

- 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

4a942c3

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

remove extra newline

f481503

add metadata file

9d43d46

edit metadata; add Berksfile

9311a37

move Berksfile to correct location

f16ecae

add testing requirements for berks vendor

19645bc

move kitchen file

ec4b489

Converge passing in test cookbook

5328995

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

Itempotence

55bed5d

- 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?

a493029

- 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

92a5e41

- 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

a734d4a

merge master to get up-to-date

be648fb

americanhanko assigned americanhanko, brownmike, ehanlon and jazaval Oct 27, 2017

americanhanko requested a review from jazaval October 27, 2017 06:13

americanhanko added the feature label Oct 27, 2017

remove .kitchen.yml

f907c49

jazaval requested changes Oct 27, 2017

View reviewed changes

Eric Hanko and others added 4 commits October 27, 2017 18:40

bump version to 0.8.5

43ea52b

unskip ChefSpec tests - they're passing

07fcc08

mark args_formatter as private method

7297d6f

Merge branch 'develop' into feature/plistbuddy

41e3037

jazaval merged commit bbe2dfc into develop Nov 8, 2017

jazaval deleted the feature/plistbuddy branch November 8, 2017 22:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add PlistBuddy Resource #12

Add PlistBuddy Resource #12

Uh oh!

americanhanko commented Oct 27, 2017 •

edited

Loading

Uh oh!

msftclas commented Oct 27, 2017 •

edited

Loading

Uh oh!

jazaval left a comment

Uh oh!

jazaval Oct 27, 2017

Uh oh!

americanhanko Oct 27, 2017 •

edited

Loading

Uh oh!

americanhanko Nov 4, 2017 •

edited

Loading

Uh oh!

jazaval Nov 8, 2017

Uh oh!

jazaval Oct 27, 2017

Uh oh!

jazaval Oct 27, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add PlistBuddy Resource #12

Add PlistBuddy Resource #12

Uh oh!

Conversation

americanhanko commented Oct 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR:

Why

Example Usage in some recipe preferences.rb

Uh oh!

msftclas commented Oct 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jazaval left a comment

Choose a reason for hiding this comment

Uh oh!

jazaval Oct 27, 2017

Choose a reason for hiding this comment

Uh oh!

americanhanko Oct 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

americanhanko Nov 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jazaval Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

jazaval Oct 27, 2017

Choose a reason for hiding this comment

Uh oh!

jazaval Oct 27, 2017

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

americanhanko commented Oct 27, 2017 •

edited

Loading

Example Usage in some recipe `preferences.rb`

msftclas commented Oct 27, 2017 •

edited

Loading

americanhanko Oct 27, 2017 •

edited

Loading

americanhanko Nov 4, 2017 •

edited

Loading