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-15598: Add a parameter to manifest list to disable filter #5498

Merged
merged 1 commit into from Sep 28, 2023

Conversation

paul-maidment
Copy link
Contributor

Recently we made a change to the manifest list to filter out the system generated manifests when listing them.

This has led to issues with data gathering for triage which requires full access to all manifests, system generated or otherwise.

I have introduced a boolean parameter IncludeSystemGenerated which defaults to false. When set to true, the manifest list endpoint will show all manifests, irrespective of how they were created.

It is intended that we will make a change in assisted-test-infra that will send this parameter.

List all the issues related to this PR

  • New Feature
  • Enhancement
  • Bug fix
  • Tests
  • Documentation
  • CI/CD

What environments does this code impact?

  • Automation (CI, tools, etc)
  • Cloud
  • Operator Managed Deployments
  • None

How was this code tested?

  • assisted-test-infra environment
  • dev-scripts environment
  • Reviewer's test appreciated
  • Waiting for CI to do a full test run
  • Manual (Elaborate on how it was tested)
  • No tests needed

Checklist

  • Title and description added to both, commit and PR.
  • Relevant issues have been associated (see CONTRIBUTING guide)
  • This change does not require a documentation update (docstring, docs, README, etc)
  • Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 18, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Sep 18, 2023

@paul-maidment: This pull request references MGMT-15598 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 bug to target the "4.15.0" version, but no target version was set.

In response to this:

Recently we made a change to the manifest list to filter out the system generated manifests when listing them.

This has led to issues with data gathering for triage which requires full access to all manifests, system generated or otherwise.

I have introduced a boolean parameter IncludeSystemGenerated which defaults to false. When set to true, the manifest list endpoint will show all manifests, irrespective of how they were created.

It is intended that we will make a change in assisted-test-infra that will send this parameter.

List all the issues related to this PR

  • New Feature
  • Enhancement
  • Bug fix
  • Tests
  • Documentation
  • CI/CD

What environments does this code impact?

  • Automation (CI, tools, etc)
  • Cloud
  • Operator Managed Deployments
  • None

How was this code tested?

  • assisted-test-infra environment
  • dev-scripts environment
  • Reviewer's test appreciated
  • Waiting for CI to do a full test run
  • Manual (Elaborate on how it was tested)
  • No tests needed

Checklist

  • Title and description added to both, commit and PR.
  • Relevant issues have been associated (see CONTRIBUTING guide)
  • This change does not require a documentation update (docstring, docs, README, etc)
  • Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

  • Are the title and description (in both PR and commit) meaningful and clear?
  • Is there a bug required (and linked) for this change?
  • Should this PR be backported?

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/test-infra repository.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 18, 2023
@openshift-ci openshift-ci bot added api-review Categorizes an issue or PR as actively needing an API review. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 18, 2023
swagger.yaml Outdated
name: include_system_generated
description: Include system generated manifests in results? Default is false.
type: boolean
required: true
Copy link
Contributor

Choose a reason for hiding this comment

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

should be optional no?

@filanov
Copy link
Contributor

filanov commented Sep 18, 2023

/assign @avishayt

@codecov
Copy link

codecov bot commented Sep 18, 2023

Codecov Report

Merging #5498 (4a8a61b) into master (2b6e4c4) will increase coverage by 0.02%.
Report is 10 commits behind head on master.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5498      +/-   ##
==========================================
+ Coverage   67.64%   67.66%   +0.02%     
==========================================
  Files         232      232              
  Lines       34099    34089      -10     
==========================================
+ Hits        23065    23067       +2     
+ Misses       8971     8965       -6     
+ Partials     2063     2057       -6     
Files Coverage Δ
internal/manifests/manifests.go 77.14% <100.00%> (ø)

... and 4 files with indirect coverage changes

@paul-maidment
Copy link
Contributor Author

/retest

1 similar comment
@paul-maidment
Copy link
Contributor Author

/retest

@@ -176,7 +176,7 @@ func (m *Manifests) ListClusterManifestsInternal(ctx context.Context, params ope
if err != nil {
return nil, err
}
if isUserManifest {
if isUserManifest || (params.IncludeSystemGenerated != nil && *params.IncludeSystemGenerated) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if isUserManifest || (params.IncludeSystemGenerated != nil && *params.IncludeSystemGenerated) {
if isUserManifest || swag.BoolValue(params.IncludeSystemGenerated) {

@paul-maidment
Copy link
Contributor Author

/retest

1 similar comment
@paul-maidment
Copy link
Contributor Author

/retest

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 26, 2023
@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 932f8e0 and 2 for PR HEAD cb2ec59 in total

Recently we made a change to the manifest list to filter out the system
generated manifests when listing them.

This has led to issues with data gathering for triage which requires
full access to all manifests, system generated or otherwise.

I have introduced a boolean parameter IncludeSystemGenerated which
defaults to false. When set to true, the manifest list endpoint will
show all manifests, irrespective of how they were created.

It is intended that we will make a change in assisted-test-infra that
will send this parameter.
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 27, 2023
@openshift-ci
Copy link

openshift-ci bot commented Sep 27, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: filanov, paul-maidment

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:
  • OWNERS [filanov,paul-maidment]

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

@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD f09956b and 2 for PR HEAD 4a8a61b in total

@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 8450824 and 1 for PR HEAD 4a8a61b in total

@openshift-ci
Copy link

openshift-ci bot commented Sep 28, 2023

@paul-maidment: 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/test-infra repository. I understand the commands that are listed here.

@openshift-merge-robot openshift-merge-robot merged commit 4658458 into openshift:master Sep 28, 2023
14 checks passed
danielerez pushed a commit to danielerez/assisted-service that referenced this pull request Oct 15, 2023
…hift#5498)

Recently we made a change to the manifest list to filter out the system
generated manifests when listing them.

This has led to issues with data gathering for triage which requires
full access to all manifests, system generated or otherwise.

I have introduced a boolean parameter IncludeSystemGenerated which
defaults to false. When set to true, the manifest list endpoint will
show all manifests, irrespective of how they were created.

It is intended that we will make a change in assisted-test-infra that
will send this parameter.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-review Categorizes an issue or PR as actively needing an API review. approved Indicates a PR has been approved by an approver from all required OWNERS files. 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.

None yet

5 participants