Skip to content

Commit

Permalink
Deprecate TLSHostnameOverride in TektonResult Properties
Browse files Browse the repository at this point in the history
Deprecating TLSHostnameOverride because it is not supported in results and is not needed.

Signed-off-by: Khurram Baig <kbaig@redhat.com>
  • Loading branch information
khrm authored and tekton-robot committed May 10, 2024
1 parent d838724 commit 1184f68
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/TektonResult.md
Expand Up @@ -98,7 +98,6 @@ spec:
logs_type: File
logs_buffer_size: 90kb
logs_path: /logs
tls_hostname_override: localhost
auth_disable: true
logging_pvc_name: tekton-logs
secret_name: # optional
Expand Down
4 changes: 4 additions & 0 deletions pkg/apis/operator/v1alpha1/tektonresult_defaults.go
Expand Up @@ -21,4 +21,8 @@ import (
)

func (tp *TektonResult) SetDefaults(ctx context.Context) {
// Deprecate TLSHostnameOverride
if tp.Spec.TLSHostnameOverride != "" {
tp.Spec.TLSHostnameOverride = ""
}
}
71 changes: 71 additions & 0 deletions pkg/apis/operator/v1alpha1/tektonresult_defaults_test.go
@@ -0,0 +1,71 @@
/*
Copyright 2024 The Tekton Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1alpha1

import (
"context"
"testing"

"github.com/google/go-cmp/cmp"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestTektonResult_SetDefaults(t *testing.T) {
tests := []struct {
name string
Spec TektonResultSpec
want TektonResultSpec
}{
{
name: "Add TLSHostnameOverride Override",
Spec: TektonResultSpec{
ResultsAPIProperties: ResultsAPIProperties{
TLSHostnameOverride: "foo.bar",
},
},
want: TektonResultSpec{
ResultsAPIProperties: ResultsAPIProperties{},
},
},
{
name: "Empty TLSHostnameOverride Override",
Spec: TektonResultSpec{
ResultsAPIProperties: ResultsAPIProperties{},
},
want: TektonResultSpec{
ResultsAPIProperties: ResultsAPIProperties{},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tp := &TektonResult{
ObjectMeta: metav1.ObjectMeta{
Name: "result",
Namespace: "foo",
},
Spec: tt.Spec,
}
tp.SetDefaults(context.Background())
if d := cmp.Diff(tt.want, tp.Spec); d != "" {
t.Errorf("TektonResult SetDefaults failed: +expected,-got: %s", d)
}

})
}
}

0 comments on commit 1184f68

Please sign in to comment.