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.

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

chore(deps): pin snowflake to v0.0.3 (#15352) #15356

Open
wants to merge 1 commit into
base: v1.8
Choose a base branch
from

Conversation

rogerpueyo
Copy link
Contributor

@rogerpueyo rogerpueyo commented Dec 12, 2023

The snowflake package used to create a UUID, e.g., for an AGW's /etc/snowflake file has been renamed to snowflake-uuid, and the former snowflake package has been taken over by a completely different piece of software. Pinning the package version to v0.0.3 ensures that we fetch the latest available release of the former snowflake package, before the name change.

Fixes #15352 for Magma v1.8.

Summary

The snowflake package dependency was pinned to v0.0.3 in both bazel/external/requirements.in and orc8r/gateway/python/setup.py. This ensures that the latest release of the former snowflake package is fetched and the /etc/snowflake file is generated correctly.

Test Plan

Tested on a v1.8 AGW in a Vagrant VM. The magmad service no longer complains about the snowflake package as detailed in #15352, and it correctly starts the rest of services. Also, the show_gateway_info.py reports a valid hardware ID (instead of miserably failing).

Additional Information

  • This change is backwards-breaking

Security Considerations

For master and upcoming ≥v1.9 Magma releases, the new package name snowflake-uuid shall be used.

@rogerpueyo rogerpueyo requested a review from a team as a code owner December 12, 2023 15:45
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines. label Dec 12, 2023
Copy link
Contributor

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@rogerpueyo
Copy link
Contributor Author

Hi, @ardzoht ,

Sorry for bothering you. I wonder if you could have a look at this PR. The snowflake dependency is currently a showstopper to deploy Magma's latest stable version, v1.8.

Some CI test failed, but I believe they are unrelated to the PR.

Thanks!

@maxhbr
Copy link
Member

maxhbr commented Feb 12, 2024

For the reviewer:

For backporting we have https://github.com/magma/magma/blob/master/.github/workflows/backport-pull-request.yml, that works based on labels. Not sure if that is still functional.

@rogerpueyo
Copy link
Contributor Author

Thanks, @maxhbr . Indeed, this commit is not a backport, just a quick fix for v1.8. When I have some time, I plan to send a PR with the proper fix to main, which consists on renaming the snowflake dependency to its current name snowflake-uuid.

@lucasgonze
Copy link
Contributor

@rogerpueyo Thanks for this. I will review today.

Copy link
Contributor

@lucasgonze lucasgonze left a comment

Choose a reason for hiding this comment

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

Researched the odd history of the package. Verified that 0.0.3 is a reasonable stopping point.

@lucasgonze
Copy link
Contributor

lucasgonze commented Feb 13, 2024

Two problems remaining:

  1. A review from @ardzoht was requested, and he is no longer a contributor.
  2. A number of tests are failing.

@lucasgonze
Copy link
Contributor

lucasgonze commented Feb 13, 2024

https://magmacore.slack.com/archives/C0191LLL03S/p1707864815948919

  1. Do we patch 1.8? If so do we test?
  2. My PR approval is from a security perspective. I would also back it in terms of software engineering but testing is out of scope for me.
  3. The submitter requested an approval from somebody who is no longer a contributor. We need to remove that approver and either have somebody else step in or just go cowboy without a second review.
  4. Unit tests are failing because of CI problems. But that doesn’t mean they would pass without the CI problems. Again, do we want to cowboy this?

The snowflake package used to create a UUID, e.g., for an AGW's
/etc/snowflake file has been renamed to snowflake-uuid, and the former
snowflake package has been taken over by a completely different piece of
software. Pinning the package version to v0.0.3 ensures that we fetch
the latest available release of the former snowflake package, before the
name change.

Fixes magma#15352 for v1.8.

Signed-off-by: Roger Pueyo Centelles <roger.pueyo@i2cat.net>
@lucasgonze
Copy link
Contributor

@panyogesh Is it possible to include this in the current round of merges?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: orc8r Orchestrator-related issue size/XS Denotes a PR that changes 0-9 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants