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

MGMT-19148: Add options parameter to ListJobs #938

Closed

Conversation

jhernand
Copy link
Contributor

This patch adds a new options metav1.ListOptions parameter to the ListJobs method of Kubernetes client interface. This new parameter will be needed in order to add support for waiting for operator setup jobs, because that will need to list jobs in all namespaces using a label selector.

In addition to adding the options the patch also changes the mock configuration so that they are more precise. Instead of this:

mockk8sclient.EXPECT().ListJobs(gomock.Any(), gomock.Any())

We use this now:

mockk8sclient.EXPECT().ListJobs(olmNamespace, metav1.ListOptions{})

That will help when introducing other tests where the parameters will be
different.

Related: https://issues.redhat.com/browse/MGMT-19148
Related: https://issues.redhat.com/browse/MGMT-19056

This change was partially done in the past, but the _Dockerfile_ wasn't
updated to use the new `mockgen` command. As a result if one installs
the `mockgen` with the command from the dockerfile and then runs `make
generate` the resulting code doesn't build:

```
$ grep mockgen Dockerfile.assisted-installer-build
  go install github.com/golang/mock/[email protected] && \

$ go install github.com/golang/mock/[email protected]

$ make generate
go generate ..
make format
make[1]: Entering directory '/files/projects/assisted-installer/repository'
make[1]: Leaving directory '/files/projects/assisted-installer/repository'

$ make build
CGO_ENABLED=0  go build -o build/installer src/main/main.go
src/main/drymock/dry_mode_k8s_mock.go:308:36: cannot use mockController (variable of type *"go.uber.org/mock/gomock".Controller) as *"github.com/golang/mock/gomock".Controller value in argument to k8s_client.NewMockK8SClient
make: *** [Makefile:68: installer] Error 1
```

To avoid this issue this patch updates the _Dockerfile_, the generated
code and the test code so that they use the same version of the mock
package.

Note that this wasn't detected by CI because we aren't running `make
generate`.

Signed-off-by: Juan Hernandez <[email protected]>
This patch adds a new `options metav1.ListOptions` parameter to the
`ListJobs` method of Kubernetes client interface. This new parameter
will be needed in order to add support for waiting for operator setup
jobs, because that will need to list jobs in all namespaces using a
label selector.

In addition to adding the options the patch also changes the mock
configuration so that they are more precise. Instead of this:

```go
mockk8sclient.EXPECT().ListJobs(gomock.Any(), gomock.Any())
```

We use this now:

```go
mockk8sclient.EXPECT().ListJobs(olmNamespace, metav1.ListOptions{})
```

That will help when introducing other tests where the parameters will be
different.

Related: https://issues.redhat.com/browse/MGMT-19148
Related: https://issues.redhat.com/browse/MGMT-19056
Signed-off-by: Juan Hernandez <[email protected]>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Oct 25, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Oct 25, 2024

@jhernand: This pull request references MGMT-19148 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.18.0" version, but no target version was set.

In response to this:

This patch adds a new options metav1.ListOptions parameter to the ListJobs method of Kubernetes client interface. This new parameter will be needed in order to add support for waiting for operator setup jobs, because that will need to list jobs in all namespaces using a label selector.

In addition to adding the options the patch also changes the mock configuration so that they are more precise. Instead of this:

mockk8sclient.EXPECT().ListJobs(gomock.Any(), gomock.Any())

We use this now:

mockk8sclient.EXPECT().ListJobs(olmNamespace, metav1.ListOptions{})

That will help when introducing other tests where the parameters will be
different.

Related: https://issues.redhat.com/browse/MGMT-19148
Related: https://issues.redhat.com/browse/MGMT-19056

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 25, 2024
@openshift-ci openshift-ci bot requested review from eliorerz and romfreiman October 25, 2024 13:48
@openshift-ci openshift-ci bot added the downstream-change-needed Requires updating downstream image label Oct 25, 2024
Copy link

openshift-ci bot commented Oct 25, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhernand

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 25, 2024
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.19%. Comparing base (1253fce) to head (e4af881).
Report is 29 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #938   +/-   ##
=======================================
  Coverage   55.19%   55.19%           
=======================================
  Files          15       15           
  Lines        3279     3279           
=======================================
  Hits         1810     1810           
  Misses       1290     1290           
  Partials      179      179           
Files with missing lines Coverage Δ
.../assisted_installer_controller/operator_handler.go 79.45% <100.00%> (ø)
...ed-installer-controller/assisted_installer_main.go 27.10% <ø> (ø)

Copy link

openshift-ci bot commented Oct 25, 2024

@jhernand: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@eranco74
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 23, 2024
@jhernand
Copy link
Contributor Author

This is no longer needed because #940 was closed.

@jhernand jhernand closed this Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. downstream-change-needed Requires updating downstream image jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants