run setup_keychain on macOS environments only

[seanreinhardtapps]

Checklist

• I've run bundle exec rspec from the root directory to see all new and existing tests pass
• I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
• I've read the Contribution Guidelines
• I've updated the documentation if necessary.

Motivation and Context

setup_travis fails on the Linux CI agents in the setup_keychain action, throwing an error and failing the task.
To run Travis CI lanes on Mac and Linux agents, setup_travis must be conditionally run.

Since that action only applies to a macOS environment, it could be updated to skip the setup_keychain step on non macOS agents.
🔑

Description

Exit early out of setup_keychain in the setup_ci action on non mac-OS envoronments, logging a message that it was skipped.

Testing Steps

• Run setup_ci on a macOS agent without any change in behavior.
• Run setup_ci on a linux agent and see that it no longer fails, and logs "Skipping Keychain setup on non-macOS CI Agent"

[googlebot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

---

What to do if you already signed the CLA

Individual signers

• It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

• Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
• The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
• The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

[seanreinhardtapps]

@googlebot I signed it!

[googlebot]

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

[janpio]

Seems you will need some special handling in the tests as well, as they are run on Linux and Windows as well.

[mollyIV]

Hey @seanreinhardtapps , @janpio 👋

The setup_ci lane has been extracted as a common piece of logic for specific CI providers. It makes maintenance and future code changes easier. Here is the full context.

According to the source code of a setup_travis lane, the action is intended to be ran only on ios and mac platforms:

fastlane/fastlane/lib/fastlane/actions/setup_travis.rb

Lines 42 to 44 in 5734f46

	def self.is_supported?(platform)
	[:ios, :mac].include?(platform)
	end

I had a look at setup_ci code and besides setting up the keychain and setting up the output paths only for a CircleCI provider, nothing is happening.

fastlane/fastlane/lib/fastlane/actions/setup_ci.rb

Lines 4 to 16 in 5734f46

	def self.run(params)
	unless should_run?(params)
	UI.message("Not running on CI, skipping CI setup")
	return
	end
	case detect_provider(params)
	when 'circleci'
	setup_output_paths
	end
	setup_keychain
	end

Taking that into account, I am wondering if setup_travis should be supported on systems other than macOS right now 🤔 Maybe we could do it just in time (when adding new functionality to the setup_travis action that could be supported on the macOS, Linux and Windows), not just in case.

@seanreinhardtapps could you please provide a bit more context, ideally a use-case, why and when you need to run setup_travis on an environment different than macOS?

[seanreinhardtapps]

@mollyIV, @janpio thanks for the reviews on this idea.
It's not my intent to actually run setup_travis on a linux agent. My thought was that the setup_travis action could skip running on a linux agent, like it already does on a non-CI environment.

When I looked into the implementation, I thought it would make more sense to skip the setup_keychain portion since thats what fails outside of a Mac, and that expands it beyond just Travis CI.

I understand it's not usual to use a linux agent for iOS tests. I'm running a multi-stage Travis config where the last stage runs a docker container on the agent and starts XCUITests on a device farm. Thought it could be just a ruby script, it's scripted into a lane along with all of our other tasks. We had setup_travis at the top of our Fastfile before the need for the linux agent. Now its run conditionally which is fine, but I thought it would be an improvement if it did so automatically.

[joshdholtz]

I think the addition of platform checking before setting up keychain makes sense! I have a few suggestions on the code in SetupCiAction and on the tests 😊 But once those are fixed I think this should be 👍

[mollyIV]

I think the addition of platform checking before setting up keychain makes sense!

👍 👍

Let's also remember to change supported platforms for a setup_travis action 😊

fastlane/fastlane/lib/fastlane/actions/setup_travis.rb

Lines 42 to 44 in 5734f46

	def self.is_supported?(platform)
	[:ios, :mac].include?(platform)
	end

[joshdholtz]

@seanreinhardtapps BTW, let me know if you want any help making changes to those tests! I'd be happy to hop in and help 😊

[seanreinhardtapps]

Thanks for the reviews! PR should be ready for another look.

[joshdholtz]

This is great! Thank you for making those changes 😊 I will get this out in a release later today for you 💪

[fastlane-bot]

Hey @seanreinhardtapps 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

[fastlane-bot]

Congratulations! 🎉 This was released as part of fastlane 2.151.0 🚀