Update Go version and dependencies to ease development #312

kichristensen · 2024-03-30T21:24:40Z

What does this change

Because of old Go version and different dependencies not supporting newer Go versions, it takes some work to get things to compile. You will get weird errors when using newer versions of Go, none of them describes what the real issue is.
Updating the Go version to 1.21 allows it to be compiled with newer versions of the Go compiler, but requires different dependencies to be updated.
The Porter version and mixins referenced is also old, so it was updated to the newest versions.
External dependencies of, e.g., Kustomize, controller-gen and Ginkgo was also very old and no longer supported, so they were also updated.

Updates the following Go packages:

Ginkgo
Gomega
Porter
Porter Magefiles

Mixins:

Kubernetes
Helm3
Exec

External dependencies:

Operator SDK
Kustomize
controller-gen
Ginkgo

Checklist

Did you write tests?
Did you write documentation?
Did you make any API changes? Update the corresponding API documentation.

Update Go to version 1.21 Updates the following Go packages: * Ginkgo * Gomega * Porter * Porter Magefiles Mixins: * Kubernetes * Helm3 * Exec External dependencies: * Operator SDK * Kustomize * controller-gen * Ginkgo Signed-off-by: Kim Christensen <[email protected]>

codecov · 2024-03-31T17:31:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.90%. Comparing base (8038a94) to head (0c1a5e0).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #312   +/-   ##
=======================================
  Coverage   68.90%   68.90%           
=======================================
  Files          15       15           
  Lines        2248     2248           
=======================================
  Hits         1549     1549           
  Misses        548      548           
  Partials      151      151

Flag	Coverage Δ
unittests	`68.90% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

troy0820 · 2024-03-31T18:20:48Z

go.mod

@@ -1,6 +1,6 @@
 module get.porter.sh/operator

-go 1.20
+go 1.21


Because you are updating this, it’ll help if you also update controller-runtime to v0.17. This dep is also at go version 1.21

troy0820 · 2024-03-31T18:36:37Z

This also means that we have to cut a new version of the operator. Older go versions will not be able to use this version as the new minimum required go version will be 1.21.

bdegeeter · 2024-03-31T20:43:49Z

Are specific features of the newer go version needed?

…

On Sun, Mar 31, 2024 at 11:37 AM, Troy Connor ***@***.***(mailto:On Sun, Mar 31, 2024 at 11:37 AM, Troy Connor <<a href=)> wrote: This also means that we have to cut a new version of the operator. Older go versions will not be able to use this version as the new minimum required go version will be 1.21. — Reply to this email directly, [view it on GitHub](#312 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/ASHJ4PDYBLL7TC24TIYLR7DY3BJUZAVCNFSM6AAAAABFP244HOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMRYHA3DGOJTGQ). You are receiving this because your review was requested.Message ID: ***@***.***>

Signed-off-by: Kim Christensen <[email protected]>

kichristensen · 2024-03-31T21:00:27Z

Are specific features of the newer go version needed?

@bdegeeter From my point for view no, this PR is only meant to solve a few problems I had when trying to build the project. I had ~3 errors that took a long time to figure out, just because I had Go 1.22 installed. I can remember 2 of them off the top of my head, one was with staticcheck during linting and the other was with controller-gen.
The errors did not mention in anyway that it had something to do with the version of Go.

But @troy0820 might have better insights to you question

bdegeeter · 2024-03-31T21:48:06Z

@bdegeeter From my point for view no, this PR is only meant to solve a few problems I had when trying to build the project. I had ~3 errors that took a long time to figure out, just because I had Go 1.22 installed. I can remember 2 of them off the top of my head, one was with staticcheck during linting and the other was with controller-gen.
The errors did not mention in anyway that it had something to do with the version of Go.

Thanks for clarifying. I'm running into similar issues with my go 1.22.1 env. IIRC, the version checking of some of the tools for the build could use a bit a refinement. It would be great to capture some of the specifics so we can make sure to address the root cause.

Any chance you're running Apple silicon? Are you getting clean local test runs? mage -v Test?

troy0820

Everything seems to compile, but you have a failing test case.

kichristensen · 2024-04-01T13:54:30Z

@bdegeeter From my point for view no, this PR is only meant to solve a few problems I had when trying to build the project. I had ~3 errors that took a long time to figure out, just because I had Go 1.22 installed. I can remember 2 of them off the top of my head, one was with staticcheck during linting and the other was with controller-gen.
The errors did not mention in anyway that it had something to do with the version of Go.

Thanks for clarifying. I'm running into similar issues with my go 1.22.1 env. IIRC, the version checking of some of the tools for the build could use a bit a refinement. It would be great to capture some of the specifics so we can make sure to address the root cause.

Any chance you're running Apple silicon? Are you getting clean local test runs? mage -v Test?

Unfortunately I'm not running on Applie silicon. I was getting clean test runs before upgrading controller-runtime. I'm currently looking into the failing test

kichristensen · 2024-04-01T13:57:10Z

Everything seems to compile, but you have a failing test case.

I'm looking into the failing test now. I found the root cause to be the breaking change, kubernetes-sigs/controller-runtime#2633 introduced in controller-runtime v0.17.0. But still haven't figured out how to fix it, so any good ideas are more than welcome, but I will continue to looking into the issue

kichristensen · 2024-04-01T19:13:30Z

After some more investigation I think I was wrong in my original assumption that it was kubernetes-sigs/controller-runtime#2633 that triggered the failing test instead I think it is kubernetes-sigs/controller-runtime#2484.
Still investigating how to fix it

kichristensen · 2024-04-01T20:31:23Z

@troy0820 All tests are should now be passing

Signed-off-by: Kim Christensen <[email protected]>

troy0820 · 2024-04-01T21:07:05Z

I don't see anything else that needs to be done so I'll approve but will not merge it until after the workflows run, etc.

kichristensen requested review from schristoff, sgettys, bdegeeter and troy0820 as code owners March 30, 2024 21:24

troy0820 reviewed Mar 31, 2024

View reviewed changes

Upgrade controller-runtime dependency

c04aef3

Signed-off-by: Kim Christensen <[email protected]>

kichristensen force-pushed the updateThings branch from c440b8a to c04aef3 Compare March 31, 2024 20:55

troy0820 reviewed Apr 1, 2024

View reviewed changes

Fix unit tests

0c1a5e0

Signed-off-by: Kim Christensen <[email protected]>

kichristensen force-pushed the updateThings branch from ee205fb to 0c1a5e0 Compare April 1, 2024 20:31

troy0820 approved these changes Apr 2, 2024

View reviewed changes

troy0820 merged commit b385a61 into getporter:main Apr 2, 2024
8 checks passed

kichristensen deleted the updateThings branch April 2, 2024 17:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Go version and dependencies to ease development #312

Update Go version and dependencies to ease development #312

kichristensen commented Mar 30, 2024

codecov bot commented Mar 31, 2024 •

edited

Loading

troy0820 Mar 31, 2024

troy0820 commented Mar 31, 2024

bdegeeter commented Mar 31, 2024 via email

kichristensen commented Mar 31, 2024 •

edited

Loading

bdegeeter commented Mar 31, 2024

troy0820 left a comment

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024 •

edited

Loading

troy0820 commented Apr 1, 2024

Update Go version and dependencies to ease development #312

Update Go version and dependencies to ease development #312

Conversation

kichristensen commented Mar 30, 2024

What does this change

Checklist

codecov bot commented Mar 31, 2024 • edited Loading

Codecov Report

troy0820 Mar 31, 2024

Choose a reason for hiding this comment

troy0820 commented Mar 31, 2024

bdegeeter commented Mar 31, 2024 via email

kichristensen commented Mar 31, 2024 • edited Loading

bdegeeter commented Mar 31, 2024

troy0820 left a comment

Choose a reason for hiding this comment

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024

kichristensen commented Apr 1, 2024 • edited Loading

troy0820 commented Apr 1, 2024

codecov bot commented Mar 31, 2024 •

edited

Loading

kichristensen commented Mar 31, 2024 •

edited

Loading

kichristensen commented Apr 1, 2024 •

edited

Loading