OCPBUGS-78802: Fix token auth annotation to use opt-in instead of opt-out

[TheRealJon]

Summary

Fixes regression where operators without explicit token-auth-aws: "true" annotation incorrectly show the ARN role field in the subscription form on AWS STS clusters.

Problem

Cluster Observability Operator (and similar operators) have features.operators.openshift.io/token-auth-aws: "false" but the ARN field was still showing in the subscription form on 4.21, even though it worked correctly in 4.20.

Root Cause

Regression introduced in commit a931fbd (Sep 9, 2024) during the "Fix JSON annotation parsing issue and harden related code" refactor.

Before refactor (correct opt-in behavior):

if (tokenAuthAWS === 'true' && isAWSSTSCluster(...)) {
  infrastructureFeatures.push(InfraFeatures.tokenAuth);
}

After refactor (buggy opt-out behavior):

const awsTokenAuthIsSupported =
  clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] !== 'false';

This changed the logic from opt-in to opt-out:

• ❌ Missing annotation → defaults to supported (shows ARN field)
• ❌ undefined !== 'false' → true (shows ARN field)
• ✅ 'false' !== 'false' → false (hides ARN field)

Solution

Restore opt-in behavior by changing condition from !== 'false' to === 'true':

const awsTokenAuthIsSupported =
  clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] === 'true';

Now operators must explicitly opt-in by setting the annotation to "true" to show credential fields.

Changes

• Fixed token auth logic for both AWS and Azure annotations in operator-hub-utils.ts
• Updated 4 existing tests to include explicit 'true' annotations
• Added 2 new regression tests:
  • Verifies TokenAuth excluded when annotation is "false"
  • Verifies TokenAuth excluded when annotation is missing

🤖 Generated with Claude Code

Summary by CodeRabbit

• Bug Fixes

  • Fixed token authentication feature gating logic for AWS STS and Azure workload identity federation clusters to require explicit 'true' configuration values instead of accepting any non-false values.

• Tests

  • Added test coverage validating token authentication feature behavior across different cluster configurations and annotation states.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: TheRealJon

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• frontend/OWNERS [TheRealJon]

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This change updates the TokenAuth feature gating logic in the operator-hub utilities to enforce stricter validation. The implementation shifts from accepting any value except 'false' to requiring the explicit string 'true' for the awsTokenAuthIsSupported and azureTokenAuthIsSupported conditions. Corresponding test coverage is expanded to validate behavior across multiple scenarios: when annotations are explicitly true, false, or absent for AWS STS and Azure WIF clusters. All existing test inputs are updated to include the new TokenAuth annotations.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the core change: fixing token auth annotations from opt-out (!== 'false') to opt-in (=== 'true') logic across AWS and Azure credential handling.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

📝 Coding Plan

• Generate coding plan for human review comments

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

[openshift-ci]

@TheRealJon: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-gcp-console	fb282fe	link	true	/test e2e-gcp-console

Full PR test history. Your PR dashboard.

Details

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.

[openshift-ci-robot]

@TheRealJon: This pull request references Jira Issue OCPBUGS-78802, which is invalid:

• expected the bug to target the "4.22.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Summary

Fixes regression where operators without explicit token-auth-aws: "true" annotation incorrectly show the ARN role field in the subscription form on AWS STS clusters.

Problem

Cluster Observability Operator (and similar operators) have features.operators.openshift.io/token-auth-aws: "false" but the ARN field was still showing in the subscription form on 4.21, even though it worked correctly in 4.20.

Root Cause

Regression introduced in commit a931fbd (Sep 9, 2024) during the "Fix JSON annotation parsing issue and harden related code" refactor.

Before refactor (correct opt-in behavior):

if (tokenAuthAWS === 'true' && isAWSSTSCluster(...)) {
 infrastructureFeatures.push(InfraFeatures.tokenAuth);
}

After refactor (buggy opt-out behavior):

const awsTokenAuthIsSupported =
 clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] !== 'false';

This changed the logic from opt-in to opt-out:

• ❌ Missing annotation → defaults to supported (shows ARN field)
• ❌ undefined !== 'false' → true (shows ARN field)
• ✅ 'false' !== 'false' → false (hides ARN field)

Solution

Restore opt-in behavior by changing condition from !== 'false' to === 'true':

const awsTokenAuthIsSupported =
 clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] === 'true';

Now operators must explicitly opt-in by setting the annotation to "true" to show credential fields.

Changes

• Fixed token auth logic for both AWS and Azure annotations in operator-hub-utils.ts
• Updated 4 existing tests to include explicit 'true' annotations
• Added 2 new regression tests:
• Verifies TokenAuth excluded when annotation is "false"
• Verifies TokenAuth excluded when annotation is missing

🤖 Generated with Claude Code

Summary by CodeRabbit

• Bug Fixes

• Fixed token authentication feature gating logic for AWS STS and Azure workload identity federation clusters to require explicit 'true' configuration values instead of accepting any non-false values.

• Tests

• Added test coverage validating token authentication feature behavior across different cluster configurations and annotation states.

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]

PR needs rebase.

Details

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.

[openshift-ci]

PR needs rebase.

Details

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.

[TheRealJon]

Duplicate of #16051

[openshift-ci-robot]

@TheRealJon: This pull request references Jira Issue OCPBUGS-78802. The bug has been updated to no longer refer to the pull request using the external bug tracker. All external bug links have been closed. The bug has been moved to the NEW state.

Details

In response to this:

Summary

Fixes regression where operators without explicit token-auth-aws: "true" annotation incorrectly show the ARN role field in the subscription form on AWS STS clusters.

Problem

Cluster Observability Operator (and similar operators) have features.operators.openshift.io/token-auth-aws: "false" but the ARN field was still showing in the subscription form on 4.21, even though it worked correctly in 4.20.

Root Cause

Regression introduced in commit a931fbd (Sep 9, 2024) during the "Fix JSON annotation parsing issue and harden related code" refactor.

Before refactor (correct opt-in behavior):

if (tokenAuthAWS === 'true' && isAWSSTSCluster(...)) {
 infrastructureFeatures.push(InfraFeatures.tokenAuth);
}

After refactor (buggy opt-out behavior):

const awsTokenAuthIsSupported =
 clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] !== 'false';

This changed the logic from opt-in to opt-out:

• ❌ Missing annotation → defaults to supported (shows ARN field)
• ❌ undefined !== 'false' → true (shows ARN field)
• ✅ 'false' !== 'false' → false (hides ARN field)

Solution

Restore opt-in behavior by changing condition from !== 'false' to === 'true':

const awsTokenAuthIsSupported =
 clusterIsAWSSTS && annotations[OLMAnnotation.TokenAuthAWS] === 'true';

Now operators must explicitly opt-in by setting the annotation to "true" to show credential fields.

Changes

• Fixed token auth logic for both AWS and Azure annotations in operator-hub-utils.ts
• Updated 4 existing tests to include explicit 'true' annotations
• Added 2 new regression tests:
• Verifies TokenAuth excluded when annotation is "false"
• Verifies TokenAuth excluded when annotation is missing

🤖 Generated with Claude Code

Summary by CodeRabbit

• Bug Fixes

• Fixed token authentication feature gating logic for AWS STS and Azure workload identity federation clusters to require explicit 'true' configuration values instead of accepting any non-false values.

• Tests

• Added test coverage validating token authentication feature behavior across different cluster configurations and annotation states.

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.