Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/nix #34

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feature/nix #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84f1ccf
Nix
krebernisak Sep 5, 2022
fd70f97
Point to env with Nix
krebernisak Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion chainlink-testing-framework/run-tests/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ runs:
using: composite
steps:
- name: Setup environment
uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-run-tests-environment@d02e09ae912c5a89a48d1b7cf36f2f35d8f98c7b # v2.0.14
uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-run-tests-environment@84f1ccf5b7459c2b8f75bd47ba96c7ffdad2e47d # v2.0.16
with:
test_download_vendor_packages_command: ${{ inputs.test_download_vendor_packages_command }}
test_download_ginkgo_command: ${{ inputs.test_download_ginkgo_command }}
Expand Down
4 changes: 4 additions & 0 deletions chainlink-testing-framework/setup-run-tests-environment/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ runs:
with:
method: kubeconfig
kubeconfig: ${{ inputs.QA_KUBECONFIG }}
- name: Install Nix
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since nix is non standard we need to add a bool input for whether we use it or not and default it to false. This might not be the best way to do this though, we may want to add a bool to the run-test action to run the setup, this would allow you to use the setup action or the nix install or both in whatever order you need before the run-test action in your workflow.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why wouldn't we adopt Nix as standard?

It's been working for us almost seamlessly, across integrations, but that's because we have @archseer who has Nix experience. He can comment on any potential toolchain conflicts. I also encourage him to start sharing his Nix knowledge more, so we can adopt it more broadly.

The implementation in this PR works for our use case: smartcontractkit/chainlink-starknet#102

Now what is the exact problem... We have this test-runner machine that the GH action spins up. It installs Go + k8s and expects the full e2e tests to run with only bash, Go and k8s. What if a developer needs something else to prepare the tests? Let's say it needs Rust, or it needs Cairo for our StarkNet use case.

The only current option is for the developer to define its environment as a Helm chart and spin that up in k8s to do the required setup (compile and deploy contracts, for example). This is a great option, but it's involved and potentially not enough if the developer really needs/wants to use the host machine for whatever reason. This is why I think Nix is a great addition and another option for the developer to define his environment and the toolchain.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The root of the problem is that you are injecting nix into the setup. These actions setup what is needed to run tests, not your specific environment. Because these are actions you can run nix before these actions if you have further setup for your environment or for whatever commands get ran in the setup and test run. For example your workflow can have steps in this order:

  1. Checkout the code
  2. install nix
  3. run-tests action (which also does the setup for the tests)

If you need the nix install to happen after the setup in run tests we can add a boolean so you can run your steps in this order:

  1. Checkout the code
  2. setup-run-tests-environment action
  3. install nix
  4. run-tests action

With how you are currently adding nix in this PR it would be no different than the first option which means you wouldn't have to make this PR at all.

uses: cachix/install-nix-action@d64e0553100205688c0fb2fa16edb0fc8663c590 # v17
with:
nix_path: nixpkgs=channel:nixos-unstable
- name: Tool Versions
shell: bash
run: |
Expand Down