ci(docker): Add tests for macOS #636

MaxymVlasov · 2024-02-23T21:23:02Z

Put an x into the box if that apply:

This PR introduces breaking change.
This PR fixes a bug.
This PR adds new functionality.
This PR enhances existing functionality.

Description of your changes

How can we test changes

.github/workflows/build-image-test.yaml

antm-pp · 2024-02-23T23:27:00Z

You may understand this better than me (and appreciate it's a work in progress so not trying to review it).

The macos-latest github runner is an amd host, and the only arm host is macos-14 (beta)

The ubuntu-latest (for private repo) is running in Azure according to this spec, and indicates it's an Intel(amd) processor.

I think there's limited ability to run an arm host as a github runner.

In terms of outcomes, (despite the comments on the other PR I've made about seeing differences between aarch64/arm64) isn't the principle test just for a build with buildx arg --platform linux/arm64 as well as the current linux/amd64. Effectively the whole workflow in parallel rather than just the multi-arch build step?

MaxymVlasov · 2024-02-24T05:27:20Z

arm64 exist for macOS 13. GH just not updated their docs
https://docs.github.com/en/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners

And matrix is a parallelism by itself, we build multiplatform image just to test that this will work, during the release

Check run workflows for the last commit
https://github.com/antonbabenko/pre-commit-terraform/actions/runs/8025437914

If there were no possibility to run arm64 runners, jobs would not start at all

MaxymVlasov · 2024-02-24T05:37:37Z

I will take a look at the container structure GHA next week. if it can be quickly fixed, I will use my fork (as it was some time ago), and merge this PR with all 4 checks.

If not - well, 2 arches for Ubuntu are still better than just 1 Ubuntu amd64 build.

Then we will be able to test your PR right away in GHA, just in case.

antm-pp · 2024-02-27T13:17:27Z

So the matrix defined still only uses runs-on {{ matrix.os }} so how does the runs-on command have any concept of the architecture? I've never seen anything in github documentation to say they provide arm64 hosts (other than the recent addition of the Mac M1 processor). I can't see anywhere in the workflow that utilises the architecture specified.

coderabbitai · 2025-05-27T22:56:51Z

📝 Walkthrough

Summary by CodeRabbit

Chores
- Expanded build and test coverage to include MacOS runners (both amd64 and arm64) in addition to existing Ubuntu runners.
- Improved workflow reliability by disabling early termination on failure.
- Enhanced Docker setup for MacOS runners to ensure compatibility and proper environment configuration.
- Updated debug and binary download steps for broader OS support.

Summary by CodeRabbit

Chores
- Updated automated build and test workflows to support both Linux and MacOS runners, including MacOS for both amd64 and arm64 architectures.
- Improved workflow reliability by preventing early termination on failure.
- Enhanced Docker setup and testing compatibility for MacOS environments.

Walkthrough

The build workflow configuration was updated to add MacOS amd64 and arm64 runners to the build matrix. A MacOS-specific step was introduced to set up Docker using a dedicated action before the Docker Buildx setup, conditional on Docker-related files changing.

Changes

File(s)	Change Summary
.github/workflows/build-image-test.yaml	Added `os-type` dimension with `linux` and `darwin` to build matrix; included MacOS amd64 and arm64 runners; introduced MacOS-only Docker setup step; updated container-structure-test URL to support MacOS binaries; set `fail-fast` to false; modified `IMAGE` env variable assignment.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant MacOS Runner
    participant Setup Docker Action
    participant Docker Buildx

    GitHub Actions->>MacOS Runner: Start job with matrix.os-type=darwin
    MacOS Runner->>Setup Docker Action: Run douglascamata/[email protected]
    Setup Docker Action->>MacOS Runner: Docker environment ready
    MacOS Runner->>Docker Buildx: Proceed with Docker Buildx setup and build steps

Suggested reviewers

antonbabenko

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc6a939 and 948df60.

📒 Files selected for processing (1)

.github/workflows/build-image-test.yaml (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/build-image-test.yaml

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: MacOS ARM
GitHub Check: MacOS x64
GitHub Check: Ubuntu x64

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

for more information, see https://pre-commit.ci

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd939dd and 5badac2.

📒 Files selected for processing (1)

.github/workflows/build-image-test.yaml (2 hunks)

.github/workflows/build-image-test.yaml

for more information, see https://pre-commit.ci

MaxymVlasov · 2025-05-31T13:42:28Z

This works for mac x64.
Mac arm still need to figure out how to fix. Better do as separate PR

MaxymVlasov · 2025-05-31T23:21:20Z

.github/workflows/build-image-test.yaml

so, as Mac docker is still a linux VM which is not described anyhow in docker inspect metadata => I assume it have no difference with standard linux build, is it make any sense to test Mac-specific docker builds at all?

docker inspect of built image on Mac x64:

docker info on Mac x64:

For context - all that started as issue from #636. Linux arm tests whete added long time ago.
Mac x64 build works in this PR, Mac arm - still not, and according to build action used here for mac - it near impossible to make it run natively

@yermulnik

I assume it have no difference with standard linux build, is it make any sense to test Mac-specific docker builds at all?

Might there be a difference around tool paths, libs, whatever the tests rely upon? Like those common diffs in POSIX (macOS) vs GNU (Linux)?
If not, then, given the info you provided, I agree that we can take macOS build as equal to Linux build.
Maybe call out for someone with macOS to validate tests provide the same outcome in Docker and on native Mac hardware? 🤔

Different tools inside linux VMs? Could be, but then it depends what users use - Docker Desktop, Rancher etc. and specific it version.

I'll close it for now, till we will face a mac-specific issues that are not detected by current tests

It's probably that I didn't get the basic point of the message: did you mean that os: macos-13 os-type: darwin in reality is a linux ubuntu-based container? What make it macOS build then? Or did you mean that underlying host is Linux anyways and hence built artifacts (like pre-compiled binaries) should be the same anyways (kinda use the same set of instructions)? 🤔 I'm definitely of context of this PR and thus most probably am mixing up things 🤷🏻

os: macos-13 os-type: darwin is Mac, but colima spin-ups Linux VM to run docker

Colima means Containers on Lima. Since Lima is aka Linux Machines. By transitivity, Colima can also mean Containers on Linux Machines.

So your concern is underlying host system and not container internals, right?

yermulnik · 2025-06-01T14:41:54Z

.github/workflows/build-image-test.yaml

+      run: |
+        docker context ls
+        # Colima usually creates the socket at ~/.colima/default/docker.sock
+        DOCKER_SOCKET_PATH=$(docker context ls | awk '{print $4}' | grep colima)


Using aws as cut is an anti-pattern

But if you change it to something like ... | awk -F$'\t' '$4 ~ /colima/ {print $3; exit}', the it makes sense (the exit is to produce only one string if there are more matches). Otherwise it should be something like ... | cut -f 4 | grep colima.

fix: Add tests for arm64 and for macOS

b8f9d1a

MaxymVlasov changed the title ~~fix: Add tests for arm64 and for macOS~~ tests: Add tests for arm64 and for macOS Feb 23, 2024

fix issues with docker on macos arm

51116cb

MaxymVlasov changed the title ~~tests: Add tests for arm64 and for macOS~~ ci: Add tests for arm64 and for macOS Feb 23, 2024

MaxymVlasov commented Feb 23, 2024

View reviewed changes

.github/workflows/build-image-test.yaml Outdated Show resolved Hide resolved

MaxymVlasov added 2 commits February 23, 2024 23:39

Build multiarch only in ubuntu amd64

df7d586

f

5583e99

This was referenced Feb 23, 2024

Container action is only supported on Linux plexsystems/container-structure-test-action#6

Open

fix(docker): Checkov installation silently fails on docker build in arm64. Workaround till issue will be fixed in checkov itself #635

Merged

MaxymVlasov mentioned this pull request Feb 26, 2024

ci(docker): Add tests for arm64 #637

Merged

4 tasks

Merge branch 'master' into fix_no_test_for_arm

6d9d53c

This comment was marked as resolved.

Sign in to view

github-actions bot added the stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 5, 2024

MaxymVlasov added on-hold Indicates that an issue or PR should not be auto-closed due to staleness. and removed stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 5, 2024

MaxymVlasov mentioned this pull request Jan 26, 2025

ci: Utilize native arm64 linux runners #784

Merged

Merge branch 'master' into fix_no_test_for_arm

eb71525

pre-commit-ci bot and others added 5 commits May 27, 2025 22:57

[pre-commit.ci] auto fixes from pre-commit.com hooks

9cac108

for more information, see https://pre-commit.ci

Update .github/workflows/build-image-test.yaml

9ec3aac

Update .github/workflows/build-image-test.yaml

677118c

Update .github/workflows/build-image-test.yaml

61bce20

Update .github/workflows/build-image-test.yaml

5badac2

coderabbitai bot reviewed May 27, 2025

View reviewed changes

.github/workflows/build-image-test.yaml Outdated Show resolved Hide resolved

.github/workflows/build-image-test.yaml Outdated Show resolved Hide resolved

MaxymVlasov and others added 2 commits May 28, 2025 02:12

Update build-image-test.yaml

98fb397

[pre-commit.ci] auto fixes from pre-commit.com hooks

ecbad24

for more information, see https://pre-commit.ci

MaxymVlasov added 5 commits May 28, 2025 02:26

Update .github/workflows/build-image-test.yaml

6e9722c

Update build-image-test.yaml

53088bd

Update build-image-test.yaml

1b9668b

Update build-image-test.yaml

2d34d2f

Update build-image-test.yaml

dfcdca3

MaxymVlasov changed the title ~~ci: Add tests for arm64 and for macOS~~ ci: Add tests for macOS May 27, 2025

MaxymVlasov added 4 commits May 28, 2025 02:46

Update build-image-test.yaml

8332068

Update build-image-test.yaml

f1f1f70

Update build-image-test.yaml

31d95c0

fix container-structure-test

7d216ef

MaxymVlasov removed the on-hold Indicates that an issue or PR should not be auto-closed due to staleness. label May 28, 2025

MaxymVlasov added 9 commits May 28, 2025 21:53

Update build-image-test.yaml

d2f9601

Update build-image-test.yaml

e50e810

Update build-image-test.yaml

0c36c1f

Update build-image-test.yaml

f7b31a7

Update build-image-test.yaml

525825c

Update build-image-test.yaml

b760886

Update build-image-test.yaml

a2bc4dd

Update build-image-test.yaml

4df69be

Update build-image-test.yaml

bbf1021

Update build-image-test.yaml

dc6a939

MaxymVlasov commented May 31, 2025

View reviewed changes

Update build-image-test.yaml

948df60

yermulnik reviewed Jun 1, 2025

View reviewed changes

MaxymVlasov changed the title ~~ci: Add tests for macOS~~ ci(docker): Add tests for macOS Jun 1, 2025

MaxymVlasov added area/docker area/macOS labels Jun 1, 2025

MaxymVlasov closed this Jun 1, 2025

MaxymVlasov deleted the fix_no_test_for_arm branch June 1, 2025 19:48

Uh oh!

ci(docker): Add tests for macOS #636

ci(docker): Add tests for macOS #636

Uh oh!

Conversation

MaxymVlasov commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of your changes

How can we test changes

Uh oh!

Uh oh!

antm-pp commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MaxymVlasov commented Feb 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MaxymVlasov commented Feb 24, 2024

Uh oh!

antm-pp commented Feb 27, 2024

Uh oh!

This comment was marked as resolved.

coderabbitai bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MaxymVlasov commented May 31, 2025

Uh oh!

MaxymVlasov May 31, 2025 • 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!

yermulnik Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

MaxymVlasov Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

yermulnik Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

MaxymVlasov Jun 2, 2025 • 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!

yermulnik Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

yermulnik Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MaxymVlasov commented Feb 23, 2024 •

edited

Loading

antm-pp commented Feb 23, 2024 •

edited

Loading

MaxymVlasov commented Feb 24, 2024 •

edited

Loading

coderabbitai bot commented May 27, 2025 •

edited

Loading

MaxymVlasov May 31, 2025 •

edited

Loading

MaxymVlasov Jun 2, 2025 •

edited

Loading