mac:(launchd) mange the WS App as a service #153

afiune · 2020-02-03T22:25:37Z

Description

This change is adding a new scripts/ folder with a shell script
called chef_workstation_app_launcher that will control the app
launcher behavior for MacOS systems.

Load the app as a service:

$ chef_workstation_app_launcher load

Remove the app as a service:

$ chef_workstation_app_launcher remove

Show launchd information about the app as a service:

$ chef_workstation_app_launcher show
{
	"LimitLoadToSessionType" = "Aqua";
	"MachServices" = {
		"sh.chef.chef-workstation.MachPortRendezvousServer.6956" = mach-port-object;
	};
	"Label" = "chef.workstation.app";
	"TimeOut" = 30;
	"OnDemand" = true;
	"LastExitStatus" = 0;
	"PID" = 6956;
	"Program" = "/Applications/Chef Workstation App.app/Contents/MacOS/Chef Workstation App";
	"ProgramArguments" = (
		"/Applications/Chef Workstation App.app/Contents/MacOS/Chef Workstation App";
	);
	"PerJobMachServices" = {
		"com.apple.tsm.portname" = mach-port-object;
		"com.apple.coredrag" = mach-port-object;
		"com.apple.axserver" = mach-port-object;
	};
};

Usage

$ /opt/chef-workstation/bin/chef_workstation_app_launcher --help
Usage: chef_workstation_app_launcher <subcommand>

Controls the Chef Workstation App launcher behavior for MacOS systems.

Subcommands:
    show      Show launchd information about the Chef Workstation App service.
    load      Bootstraps the Chef Workstation App service.
    remove    Removes the Chef Workstation App service.

Signed-off-by: Salim Afiune afiune@chef.io

Related Issue

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

I have read the CONTRIBUTING document.
I have run the pre-merge tests locally and they pass.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
All commits have been signed-off for the Developer Certificate of Origin.

This change is adding a new `scripts/` folder with a shell script called `chef_workstation_app_launcher` that will control the app launcher behavior for MacOS systems. Load the app as a service: ``` $ chef_workstation_app_launcher load ``` Remove the app as a service: ``` $ chef_workstation_app_launcher remove ``` Signed-off-by: Salim Afiune <afiune@chef.io>

Show launchd information about the Chef Workstation App service. Signed-off-by: Salim Afiune <afiune@chef.io>

This change has a dependency to chef/chef-workstation-app#153 Signed-off-by: Salim Afiune <afiune@chef.io>

afiune · 2020-02-04T15:34:38Z

Launched an ad hoc build but for some reason the MacOS packages are not being
tagged correctly so I can't find the correct package, I am trying to build locally now.

…into afiune/chef_workstation_app_launcher

Signed-off-by: Salim Afiune <afiune@chef.io>

afiune · 2020-02-04T22:18:01Z

With the commit chef/chef-workstation@1637621 now the ad hoc build is passing

cc/ @jonsmorrow

tyler-ball

Code looks clear to me. Did you get the launcher script based on anything existing?

afiune · 2020-02-04T22:32:27Z

@tyler-ball nope. I just made my own 😂 I did read the man page for the launchd daemon agent:

https://www.manpagez.com/man/5/launchd.plist/

tyler-ball · 2020-02-04T22:32:48Z

Even more impressive!

afiune · 2020-02-04T22:38:54Z

@tyler-ball I wanna disclose that, I had already thought about this launcher script
since I needed to control the "start at boot" via a checkbox inside the Preferences
Dialog (PR #125). Now, with this script, we will be able in the future to control such
behavior by adding an extra sub-command called (maybe) disable.

Idea:

$ /opt/chef-workstation/bin/chef_workstation_app_launcher --help
Usage: chef_workstation_app_launcher <subcommand>

Controls the Chef Workstation App launcher behavior for MacOS systems.

Subcommands:
    show      Show launchd information about the Chef Workstation App service.
    load      Bootstraps the Chef Workstation App service.
    remove    Removes the Chef Workstation App service.
    disable   Disable the Chef Workstation App to start at boot.

tas50 · 2020-02-05T00:54:33Z

assets/scripts/chef_workstation_app_launcher

+  cat <<DOC
+Usage: ${PROGNAME} <subcommand>
+
+Controls the ${PRODUCTNAME} launcher behavior for MacOS systems.


Suggested change

Controls the ${PRODUCTNAME} launcher behavior for MacOS systems.

Controls the ${PRODUCTNAME} launcher behavior for macOS systems.

tas50 · 2020-02-05T00:54:41Z

assets/scripts/chef_workstation_app_launcher

+main()
+{
+  if ! is_darwin; then
+    error_exit "Launcher is only available for MacOS systems"


Suggested change

error_exit "Launcher is only available for MacOS systems"

error_exit "Launcher is only available for macOS systems"

jonsmorrow

LGTM. My only comment is that it might make sense to make this generic so the api is chef_workstation_launcher load app this way it could potentially be used for future services too. Also that's a change we could make later so long as this is never a public api.

afiune · 2020-02-05T20:46:26Z

@jonsmorrow I will change it. My only concern is that users might get confused by the name today since this is very specific for the WS App. Hopefully not 🤞

jonsmorrow · 2020-02-05T21:25:33Z

@afiune we could add to the help output a list of supported options or have it launch all without an argument

afiune · 2020-02-05T21:30:11Z

@jonsmorrow it already does that 💯

Signed-off-by: Salim Afiune <afiune@chef.io>

This change has a dependency to chef/chef-workstation-app#153 Signed-off-by: Salim Afiune <afiune@chef.io>

Salim Afiune added 2 commits February 3, 2020 15:13

chef_workstation_app_launcher:(show) launchd info

0ec15c9

Show launchd information about the Chef Workstation App service. Signed-off-by: Salim Afiune <afiune@chef.io>

afiune added Aspect: Stability Consistent results. Platform: macOS Type: Enhancement Adds new functionality. Triage: Feature Request Indicates an issue requesting new functionality. labels Feb 3, 2020

afiune self-assigned this Feb 3, 2020

afiune requested review from a team February 3, 2020 22:25

afiune pushed a commit to chef/chef-workstation that referenced this pull request Feb 3, 2020

mac_os:(launcher) run at boot

b4692ec

This change has a dependency to chef/chef-workstation-app#153 Signed-off-by: Salim Afiune <afiune@chef.io>

afiune mentioned this pull request Feb 3, 2020

mac_os:(launcher) run at boot chef/chef-workstation#913

Merged

10 tasks

afiune pushed a commit to chef/chef-workstation that referenced this pull request Feb 3, 2020

mac_os:(launcher) run at boot

de1f56f

This change has a dependency to chef/chef-workstation-app#153 Signed-off-by: Salim Afiune <afiune@chef.io>

Salim Afiune added 3 commits February 4, 2020 14:17

Merge branch 'master' of https://github.com/chef/chef-workstation-app …

7550513

…into afiune/chef_workstation_app_launcher

chef_workstation_app_launcher:(sh) enforce arguments

e28bc5b

Signed-off-by: Salim Afiune <afiune@chef.io>

rename:(plist) use domain io.chef

2e8c4b1

Signed-off-by: Salim Afiune <afiune@chef.io>

tyler-ball approved these changes Feb 4, 2020

View reviewed changes

tas50 reviewed Feb 5, 2020

View reviewed changes

jonsmorrow reviewed Feb 5, 2020

View reviewed changes

review:(typos) correct macOS

d0d9a3e

Signed-off-by: Salim Afiune <afiune@chef.io>

jonsmorrow approved these changes Feb 5, 2020

View reviewed changes

jonsmorrow merged commit c2ff7b3 into master Feb 5, 2020

chef-expeditor bot deleted the afiune/chef_workstation_app_launcher branch February 5, 2020 23:36

afiune pushed a commit to chef/chef-workstation that referenced this pull request Feb 5, 2020

mac_os:(launcher) run at boot

29a090e

This change has a dependency to chef/chef-workstation-app#153 Signed-off-by: Salim Afiune <afiune@chef.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mac:(launchd) mange the WS App as a service #153

mac:(launchd) mange the WS App as a service #153

afiune commented Feb 3, 2020 •

edited

Loading

afiune commented Feb 4, 2020

afiune commented Feb 4, 2020

tyler-ball left a comment

afiune commented Feb 4, 2020

tyler-ball commented Feb 4, 2020

afiune commented Feb 4, 2020 •

edited

Loading

tas50 Feb 5, 2020

tas50 Feb 5, 2020

jonsmorrow left a comment

afiune commented Feb 5, 2020

jonsmorrow commented Feb 5, 2020 •

edited

Loading

afiune commented Feb 5, 2020

	Controls the ${PRODUCTNAME} launcher behavior for MacOS systems.
	Controls the ${PRODUCTNAME} launcher behavior for macOS systems.

	error_exit "Launcher is only available for MacOS systems"
	error_exit "Launcher is only available for macOS systems"

mac:(launchd) mange the WS App as a service #153

mac:(launchd) mange the WS App as a service #153

Conversation

afiune commented Feb 3, 2020 • edited Loading

Description

Usage

Related Issue

Types of changes

Checklist:

afiune commented Feb 4, 2020

afiune commented Feb 4, 2020

tyler-ball left a comment

Choose a reason for hiding this comment

afiune commented Feb 4, 2020

tyler-ball commented Feb 4, 2020

afiune commented Feb 4, 2020 • edited Loading

tas50 Feb 5, 2020

Choose a reason for hiding this comment

tas50 Feb 5, 2020

Choose a reason for hiding this comment

jonsmorrow left a comment

Choose a reason for hiding this comment

afiune commented Feb 5, 2020

jonsmorrow commented Feb 5, 2020 • edited Loading

afiune commented Feb 5, 2020

afiune commented Feb 3, 2020 •

edited

Loading

afiune commented Feb 4, 2020 •

edited

Loading

jonsmorrow commented Feb 5, 2020 •

edited

Loading