salt: 3006.5 (new cask) #162371

cdalvaro · 2023-12-12T23:35:08Z

Important: Do not tick a checkbox if you haven’t performed its action. Honesty is indispensable for a smooth review process.

After making any changes to a cask, existing or new, verify:

The submission is for a stable version or documented exception.
brew audit --cask --online salt is error-free.
brew style --fix salt reports no offenses.

Additionally, if adding a new cask:

Named the cask according to the token reference.
Checked the cask was not already refused.
Checked the cask is submitted to the correct repo.
brew audit --cask --new salt worked successfully.
- This check fails because there is a formula in the core repo called salt. Although that formula is deprecated and this cask is intended to replace it.
brew install --cask salt worked successfully.
brew uninstall --cask salt worked successfully.

cdalvaro · 2023-12-12T23:36:11Z

This cask is a replacement for the deprecated and disabled salt formula. Maybe it's time to remove the salt formula from the core repository?

cdalvaro · 2023-12-13T09:17:01Z

This cask is a replacement for the deprecated and disabled salt formula. Maybe it's time to remove the salt formula from the core repository?

I would like to know @SMillerDev's opinion about this.

SMillerDev · 2023-12-13T09:23:24Z

Sounds fine to me, it's been deprecated and disabled for a while already.

bevanjkay · 2023-12-13T12:30:16Z

Casks/s/salt.rb

+  postflight do
+    random_str = (0...8).map { rand(65..90).chr }.join
+    %w[api master minion syndic].each do |daemon|
+      plist_file = "/Library/LaunchDaemons/com.saltstack.salt.#{daemon}.plist"
+      xml, = system_command! "plutil",
+                             args: ["-convert", "xml1", "-o", "-", "--", plist_file],
+                             sudo: true
+      xml = Plist.parse_xml(xml)
+
+      xml["EnvironmentVariables"] = {} unless xml.key?("EnvironmentVariables")
+      xml["EnvironmentVariables"]["HOMEBREW_PREFIX"] = HOMEBREW_PREFIX.to_s
+
+      path = xml["EnvironmentVariables"]["PATH"] || "/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+      path = "#{HOMEBREW_PREFIX}/bin:#{path}" unless path.split(":").include?("#{HOMEBREW_PREFIX}/bin")
+      xml["EnvironmentVariables"]["PATH"] = path
+
+      new_plist_file = "/tmp/#{random_str}.#{File.basename(plist_file)}"
+      File.write(new_plist_file, xml.to_plist)
+      system_command! "plutil",
+                      args: ["-lint", new_plist_file]
+
+      system_command! "mv",
+                      args: [new_plist_file, plist_file],
+                      sudo: true
+      system_command! "chown",
+                      args: ["root:wheel", plist_file],
+                      sudo: true
+    end
+  end


Can you provide some commentary on why this postflight block is necessary, and perhaps add a comment to code explaining it succinctly?

Of course!

The postflight is intended to add the HOMEBREW_PREFIX to the environment in order to make salt fully compatible with homebrew. Some modules require this environment variable to find not linked libraries. So, considering that this cask is being installed using homebrew, it is a valid assumption that we want that salt can find homebrew libraries.

This is an example of salt looking for HOMEBREW_PREFIX env variable. Also, in this PR, the use of this variable is added: saltstack/salt#64924

Apart of HOMEBREW_PREFIX, the PATH variable is also updated (only if needed) to include homebrew binaries.

I can add a comment to the postflight code explaining this if you think it would be useful!

I don't think we should use a post block to fix the deficiencies in salt.

So, as an alternative, could this be handled as an optional step, disabled by default?

No, it should be fixed upstream

OK... My last idea is to add some information in the caveats. So people can manually add these variables if needed. What do you think?

Maybe make an issue/PR upstream and link there with a caveat?

I'll try to improve this PR: saltstack/salt#64924

So, I think neither the modification of the plist files, nor the caveats documentation will be necessary.

postflight removed

SMillerDev · 2023-12-15T10:32:04Z

Casks/s/salt.rb

+
+      Load services you need:
+
+      sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.api


Shouldn't this be a .plist?

SMillerDev · 2023-12-15T10:33:16Z

Casks/s/salt.rb

+      After installation, configure the Salt minion ID, and the Salt master location,
+      replacing the placeholder text with custom information:
+
+      sudo salt-config -i [MINION_ID] -m [SALT_MASTER_HOST]
+
+      See Configure the Salt master and minions for more configuration options:
+      https://docs.saltproject.io/salt/install-guide/en/latest/topics/configure-master-minion.html


Since this is not a homebrew specific instruction I don't think it should be a caveat

bevanjkay · 2023-12-18T01:33:10Z

Casks/s/salt.rb

+    regex(/salt-(\d+(?:\.\d+)?(?:-\d+)?)-py3-#{arch}\.pkg/)
+  end
+
+  conflicts_with formula: "salt"


Now that salt has been removed from homebrew-core, this line needs to be removed here too.

SMillerDev · 2023-12-18T06:51:23Z

Casks/s/salt.rb

+      After installation, configure the Salt minion ID, and the Salt master location,
+      replacing the placeholder text with custom information:
+
+      sudo salt-config -i [MINION_ID] -m [SALT_MASTER_HOST]
+


Since this is not specific to the Homebrew install.

Suggested change

After installation, configure the Salt minion ID, and the Salt master location,

replacing the placeholder text with custom information:

sudo salt-config -i [MINION_ID] -m [SALT_MASTER_HOST]

SMillerDev · 2023-12-18T06:51:53Z

Casks/s/salt.rb

+
+      sudo salt-config -i [MINION_ID] -m [SALT_MASTER_HOST]
+
+      Load services you need:


Suggested change

Load services you need:

Included services:

bevanjkay · 2023-12-18T22:18:31Z

Casks/s/salt.rb

+
+  url "https://repo.saltproject.io/salt/py3/macos/minor/#{version}/salt-#{version}-py3-#{arch}.pkg"
+  name "Salt"
+  desc "World's fastest, most intelligent and scalable automation engine"


Suggested change

desc "World's fastest, most intelligent and scalable automation engine"

desc "Automation and infrastructure management engine"

bevanjkay · 2023-12-18T22:19:10Z

Casks/s/salt.rb

+  zap trash: [
+    "/etc/salt",
+  ]


Suggested change

zap trash: [

"/etc/salt",

]

zap trash: "/etc/salt"

bevanjkay · 2023-12-18T22:22:14Z

Casks/s/salt.rb

+
+  livecheck do
+    url "https://repo.saltproject.io/salt/py3/macos/latest"
+    regex(/salt-(\d+(?:\.\d+)?(?:-\d+)?)-py3-#{arch}\.pkg/)


Suggested change

regex(/salt-(\d+(?:\.\d+)?(?:-\d+)?)-py3-#{arch}\.pkg/)

regex(/salt[._-]v?(\d+(?:\.\d+)+)-py3-#{arch}\.pkg/)

bevanjkay · 2023-12-19T08:13:38Z

Thanks @cdalvaro

Using ci-syntax-only to skip the token conflict check.

BrewTestBot added the new cask label Dec 12, 2023

cdalvaro mentioned this pull request Dec 13, 2023

salt: Remove disabled formula Homebrew/homebrew-core#157157

Merged

3 tasks

bevanjkay reviewed Dec 13, 2023

View reviewed changes

bevanjkay changed the title ~~salt: 3006.5~~ salt: 3006.5 (new cask) Dec 13, 2023

cdalvaro force-pushed the salt-3006.5 branch 2 times, most recently from db71ecd to 9ee2b06 Compare December 14, 2023 16:57

SMillerDev reviewed Dec 15, 2023

View reviewed changes

cdalvaro force-pushed the salt-3006.5 branch from 9ee2b06 to cf48511 Compare December 15, 2023 20:02

bevanjkay reviewed Dec 18, 2023

View reviewed changes

SMillerDev reviewed Dec 18, 2023

View reviewed changes

cdalvaro force-pushed the salt-3006.5 branch from cf48511 to ab69a64 Compare December 18, 2023 22:10

bevanjkay requested changes Dec 18, 2023

View reviewed changes

bevanjkay reviewed Dec 18, 2023

View reviewed changes

salt: 3006.5 (new cask)

9f030a2

cdalvaro force-pushed the salt-3006.5 branch from ab69a64 to 9f030a2 Compare December 19, 2023 07:41

bevanjkay added the ci-syntax-only Only run syntax checks on CI. Use only for bulk changes. label Dec 19, 2023

bevanjkay approved these changes Dec 19, 2023

View reviewed changes

bevanjkay enabled auto-merge December 19, 2023 08:13

bevanjkay merged commit 89a7b34 into Homebrew:master Dec 19, 2023
8 of 10 checks passed

cdalvaro deleted the salt-3006.5 branch December 19, 2023 08:21

cdalvaro mentioned this pull request Dec 19, 2023

[FEATURE REQUEST] macOS arm64 Support (on repo.saltproject.io/osx/) saltstack/salt#60560

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

salt: 3006.5 (new cask) #162371

salt: 3006.5 (new cask) #162371

cdalvaro commented Dec 12, 2023 •

edited

Loading

cdalvaro commented Dec 12, 2023 •

edited

Loading

cdalvaro commented Dec 13, 2023

SMillerDev commented Dec 13, 2023

bevanjkay Dec 13, 2023

cdalvaro Dec 13, 2023

SMillerDev Dec 14, 2023

cdalvaro Dec 14, 2023

SMillerDev Dec 14, 2023

cdalvaro Dec 14, 2023

SMillerDev Dec 14, 2023

cdalvaro Dec 14, 2023

cdalvaro Dec 14, 2023

SMillerDev Dec 15, 2023

cdalvaro Dec 15, 2023

SMillerDev Dec 15, 2023

cdalvaro Dec 15, 2023

bevanjkay Dec 18, 2023

cdalvaro Dec 18, 2023

SMillerDev Dec 18, 2023

cdalvaro Dec 18, 2023

SMillerDev Dec 18, 2023

cdalvaro Dec 18, 2023

bevanjkay Dec 18, 2023 •

edited

Loading

cdalvaro Dec 19, 2023

bevanjkay Dec 18, 2023

cdalvaro Dec 19, 2023

bevanjkay Dec 18, 2023

cdalvaro Dec 19, 2023

bevanjkay commented Dec 19, 2023


		Load services you need:

		sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.api


		sudo salt-config -i [MINION_ID] -m [SALT_MASTER_HOST]

		Load services you need:

	desc "World's fastest, most intelligent and scalable automation engine"
	desc "Automation and infrastructure management engine"

	regex(/salt-(\d+(?:\.\d+)?(?:-\d+)?)-py3-#{arch}\.pkg/)
	regex(/salt[._-]v?(\d+(?:\.\d+)+)-py3-#{arch}\.pkg/)

salt: 3006.5 (new cask) #162371

salt: 3006.5 (new cask) #162371

Conversation

cdalvaro commented Dec 12, 2023 • edited Loading

cdalvaro commented Dec 12, 2023 • edited Loading

cdalvaro commented Dec 13, 2023

SMillerDev commented Dec 13, 2023

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

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

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

Choose a reason for hiding this comment

bevanjkay Dec 18, 2023 • edited Loading

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

bevanjkay commented Dec 19, 2023

cdalvaro commented Dec 12, 2023 •

edited

Loading

cdalvaro commented Dec 12, 2023 •

edited

Loading

bevanjkay Dec 18, 2023 •

edited

Loading