Merge pull request #278 from microsoft/release/5.1.0

Release/5.1.0

Author: jazaval

.gitignore

@@ -26,6 +26,7 @@ tags
 */tags
 .chef
 results
+*.bak
 
 # You should check in your Gemfile.lock in applications, and not in gems
 external_tests/*.lock

CHANGELOG.md

@@ -1,28 +1,47 @@
 # Changelog
 
+## [5.1.0] - 2023-06-27
+
+### Fixed
+
+- Fixed issues with ARD not working on macOS Monterey.
+- Ensured that CLT demand file always exists before we query the SWU catalog.
+
+### Added
+
+- Added additional functionality to the [remote_management](resources/remote_management.rb) resource.
+  - You can now specify the users to whose privileges will be configured.
+  - You can now specify the privileges to bestow upon the given users.
+  - You can now set the computer info fields; this is helpful for stratifying computers within ARD.
+
 ## [5.0.6] - 2023-06-23
 
 ### Fixed
-- Fixed permissions issue with the `macos::command_line_tools` resource. 
+
+- Fixed permissions issue with the `macos::command_line_tools` resource.
 
 ## [5.0.5] - 2023-06-20
 
 ### Fixed
+
 - Updated `command_line_tools` so that machines are able to install previously installed command line tools if they were wiped from a major macOS upgrade.
 
 ## [5.0.4] - 2023-01-31
 
 ### Added
+
 - Added key `LastPrivacyBundleVersion` to `macos_user` resource to allow for dimissing more Welcome screens in macOS 12.6.3
 
 ## [5.0.3] - 2022-11-16
 
 ### Fixed
+
 - Xcode resource verifies that a `xcodebuild` command can be ran when checking to see if Xcode is installed, in addition to verifying that Xcode.app exists.
 
 ## [5.0.2] - 2022-09-08
 
 ### Added
+
 - Xcode resource logs the Xcode version to install computed from the provided version.
 - Xcode library supports calling the `version` property more than once by not changing the stored data type.
 

README.md

@@ -10,13 +10,11 @@ Chef resources and recipes for managing and provisioning macOS.
 
 ## Officially Supported Chef Versions
 
-- Chef 16
 - Chef 17
+- Chef 18
 
 ## Officially Supported OS Versions
 
-- macOS 10.14 Mojave
-- macOS 10.15 Catalina
 - macOS 11 Big Sur
 - macOS 12 Monterey
 

azure-pipelines.yml

@@ -47,10 +47,9 @@ jobs:
 - template: test-kitchen.yml@templates
   parameters:
     platforms:
-    - mojave-chef17
-    - catalina-chef17
-    - big-sur-chef17
-    - monterey-chef17
+    - big-sur-x86
+    - monterey-x86
+    # - ventura-arm
     suites:
     - default
     - software-updates

documentation/resource_command_line_tools.md

@@ -1,44 +1,44 @@
 # command_line_tools
 
-The [``command_line_tools``](https://github.com/Microsoft/macos-cookbook/blob/master/resources/command_line_tools.rb) resource manages the state of a single Xcode Command Line Tools installation, and will only install the latest version for the current running version of macOS.
+The [`command_line_tools`](https://github.com/Microsoft/macos-cookbook/blob/master/resources/command_line_tools.rb) resource manages the state of a single Xcode Command Line Tools installation, and will only install the latest version for the current running version of macOS.
 
 ## Syntax
 
 ```ruby
-command_line_tools 'name' do
+command_line_tools 'name' do # defaults to '' if not specified
   compile_time true, false # defaults to false if not specified
   action Symbol # defaults to :install if not specified
 end
 ```
 
 where:
 
-- ``command_line_tools`` is the resource.
-- ``name`` is the name given to the resource block.
-- ``action`` identifies which steps the chef-client will take to bring the node into the desired state.
-- ``compile_time`` is the property available to this resource.
+- `command_line_tools` is the resource.
+- `name` is the name given to the resource block, which is optional.
+- `action` identifies which steps the chef-client will take to bring the node into the desired state.
+- `compile_time` is the property available to this resource.
 
 ## Actions
 
-The ``command_line_tools`` resource has the following actions:
+The `command_line_tools` resource has the following actions:
 
-``:install``
+`:install`
 
-      Default. Install Command Line Tools from Apple. Takes no action if any version has previously been installed on the system. 
+      Default. Install Command Line Tools from Apple. Takes no action if any version has previously been installed on the system, unless that version has been deleted, in which case it will attempt to install that version again.
 
-``:upgrade``
+`:upgrade`
 
-      Check for an updated version of Command Line Tools and install them if available. 
+      Check for an updated version of Command Line Tools and install them, unless the latest version is already installed.
 
-``:nothing``
+`:nothing`
 
       This resource block does not act unless notified by another resource to take action. Once notified, this resource block either runs immediately or is queued up to run at the end of the Chef Client run.
 
 ## Properties
 
-``compile_time``
+`compile_time`
 
-      **Ruby Type:** true, false | **Default Value:** ``false``
+      **Ruby Type:** true, false | **Default Value:** `false`
 
       Install the Xcode Command Line Tools at compile time.
 
@@ -47,7 +47,7 @@ The ``command_line_tools`` resource has the following actions:
 ### Install Xcode Command Line Tools
 
 ```ruby
-command_line_tools 'random_name'
+command_line_tools
 ```
 
 If running **macOS 10.14.2**, it will install **'Command Line Tools (macOS Mojave version 10.14) for Xcode-10.14'** via the `softwareupdate` utility.

documentation/resource_remote_management.md

@@ -1,50 +1,63 @@
 remote_management
 ===
 
-Use the **remote_management** resource to manage the "Remote Management" settings, found in System
-Preferences > Sharing > Remote Management. Under the hood, the [**remote_management**](https://github.com/Microsoft/macos-cookbook/blob/master/resources/remote_management.rb) resource
-executes the `kickstart` command, located in ARDAgent.app (one of macOS' "core services").
+Use the **remote_management** resource to manage the "Remote Management" settings in System Preferences > Sharing > Remote Management. Under the hood, the [remote_management](../resources/remote_management.rb) resource utilizes the [kickstart](https://ss64.com/osx/kickstart.html) script.
 
 Syntax
 ------
 
-The **remote_management** resource block declares a basic description of the command configuration
-and an action executed. For example:
-
 ```ruby
-remote_management 'enable remote management' do
-  action :enable
+remote_management 'configure remote management' do
+  users         [String, Array]           
+  privileges    [String, Array] 
+  computer_info [String, Array]          
 end
 ```
 
-where
-
-- `:enable` activates remote management and configures full privileges for all users on the system.
-- `:disable` deactivates the remote management agent and prevents it from activating at boot time.
-
-The default `:enable` action is equivalent to configuring the following
-**System Preferences > Sharing** settings:
-
-![Sharing Preferences](sharing_preferences.png)
-
-The full syntax for all of the properties that are available to the **remote_management**
-resource is:
-
-```ruby
-remote_management 'description' do
-  action                         Symbol # defaults to [:enable] if not specified
-end
-```
+Properties
+-------
 
+* `users`
+  * **Description:** the user(s) whoose ARD privileges will be configured.
+  * **Usage:** a single user can be specified in the form of a string, or multiple users can be specified as an array of strings. Specifying 'all' is a special case; all local users will be configured.
+  * **Default:** `'all'`
+    * Privileges will be configured for all local users.
+  * **Constraints:** specified users must exist on the system.
+  <br></br>
+
+* `privileges`
+  * **Description:** the desired privileges to bestow upon the given user(s).
+  **Usage:** a single privilege can be specified in the form of a string, or multiple privileges can be specified as an array of strings.
+  * **Default:** `'all'`
+  * **Constraints:** the list of optional privileges bellow
+    * `all` → grant all privileges (default)
+    * `none` → disable all privileges for the specified user
+    * `DeleteFiles` → delete files
+    * `TextMessages` → send a text message
+    * `OpenQuitApp` → open and quit applications
+    * `GenerateReport` → generate reports
+    * `RestartShutDown` → restart *and/or* shutdown
+    * `SendFile` → send *and/or* retrieve files
+    * `ChangeSetting` → change system settings
+    * `ShowObserve` → show the client when being observed or controlled
+    * `ControlObserve` → control AND observe (unless ObserveOnly is also specified)
+    * `ObserveOnly` → modify ControlObserve option to allow Observe mode only
+  <br></br>
+  
+* `computer_info`
+  * **Description:** Info fields; helpful for stratifying computers in the ARD client app.
+  * **Usage** a single info field can be added as a string, or multiple info fields can be added as an array of strings. 
+  * **Default:** `[]`
+    * No info fields will be added.
+  * **Constraints:** there is a maximum of four info fields allowed.
+  
 Actions
 -------
 
-This resource has the following actions:
-
-`:enable`
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Activate remote management and configure full privileges for all users on the system.
-
-`:disable`
+* `enable`
+  * **Description:** activate remote management and configure full privileges for all users on the system.
+  * **GUI Equivalent:** activating with the privileges property set to 'all' is equivalent to the following: 
+    ![Sharing Preferences](sharing_preferences.png)
 
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deactivate the remote management agent and prevent it from activating at boot time.
+* `disable`
+  * **Description:** deactivate the remote management agent and prevent it from activating at boot time.

kitchen.yml

@@ -7,6 +7,7 @@ driver:
 
 provisioner:
   product_name: chef
+  product_version: 18
   multiple_converge: 2
 
 verifier:
@@ -19,33 +20,25 @@ verifier:
   - test/integration/default
 
 platforms:
-- name: mojave-chef17
+- name: big-sur-x86
   driver:
-    box: microsoft/macos-mojave
-    box_version: 10.14.6
-  provisioner:
-    product_version: 17
+    box: microsoft/macos-big-sur
+    box_version: 11.7.8
 
-- name: catalina-chef17
+- name: monterey-x86
   driver:
-    box: microsoft/macos-catalina
-    box_version: 10.15.7
-  provisioner:
-    product_version: 17
+    box: microsoft/macos-monterey
+    box_version: 12.6.7
 
-- name: big-sur-chef17
+- name: ventura-x86
   driver:
-    box: microsoft/macos-big-sur
-    box_version: 11.6.5
-  provisioner:
-    product_version: 17
+    box: microsoft/macos-ventura
+    box_version: 13.4
 
-- name: monterey-chef17
+- name: ventura-arm
   driver:
-    box: microsoft/macos-monterey
-    box_version: 12.6.3
-  provisioner:
-    product_version: 17
+    box: microsoft/macos-ventura-arm
+    box_version: 13.4.1
 
 suites:
 - name: default
@@ -104,7 +97,7 @@ suites:
   - recipe[macos_test::command_line_tools]
   verifier:
     controls:
-    - command-line-tool-sentinel
+    - command-line-tool-demand
     - xcrun
 
 - name: certificate

libraries/command_line_tools.rb

@@ -6,20 +6,20 @@ class CommandLineTools
     attr_reader :version
 
     def initialize
-      @version = if installed.empty?
+      @version = if install_receipts.empty?
                    latest_from_catalog
                  else
-                   latest_installed
+                   latest_receipt
                  end
     end
 
-    def installed
+    def install_receipts
       packages = Plist.parse_xml(install_history_plist)
       packages.select { |package| package['displayName'].match? 'Command Line Tools' }
     end
 
-    def latest_installed
-      [installed.last['displayName'], installed.last['displayVersion']].join '-'
+    def latest_receipt
+      [install_receipts.last['displayName'], install_receipts.last['displayVersion']].join '-'
     end
 
     def latest_from_catalog
@@ -46,17 +46,17 @@ def recommend_version(software_update_package_list)
     end
 
     def all_available
-      softwareupdate_list.select { |product_name| product_name.match /\*.{1,8}Command Line Tools/ }
+      softwareupdate_list.select { |product_name| product_name.match(/\*.{1,8}Command Line Tools/) }
     end
 
     def platform_specific
       all_available.select { |product_name| product_name.include? macos_version }
     end
 
     def enable_install_on_demand
-      install_sentinel = '/tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress'
-      FileUtils.touch install_sentinel
-      FileUtils.chown 'root', 'wheel', install_sentinel
+      install_demand = '/tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress'
+      FileUtils.touch install_demand
+      FileUtils.chown 'root', 'wheel', install_demand
     end
 
     def xcode_version(product)