[test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go #195

art-tapin · 2023-05-29T19:31:51Z

This pull request completes the unit tests for the k8s_utils.go file, addressing the remaining functions and adding additional coverage and imporvements to the yaml_decoder.go file.

Changes Made:
k8s_utils.go

Added unit test to ObjectKeyListDifference, ContainsObjectKey, FindObjectKey, FindDeploymentStatusCondition

yaml_decoder.go

Added unit tests and comment DecodeFile

Changes made to DecodeFile, see c127731

Additional Information:

This PR is the final part (part 3 of 3) of the unit tests and improvements for the k8s_utils.go file.
It includes the unit-tests for the last function mentioned in issue Improve test coverage for package common #167,
It also marks the completion of the work for issue Improve test coverage for package common #167. (closes Improve test coverage for package common #167)
The final test coverage: 83.8% of statements, significantly improving the overall code quality (initial 52.0%).

Please note that the previous PRs have been merged and this PR concludes the work for issue #167.

Note also that this PR includes unmerged commits from #191

Coverage: 83.8%.

pkg/common/yaml_decoder_test.go

pkg/common/k8s_utils_test.go

pkg/common/yaml_decoder_test.go

pkg/common/yaml_decoder.go

…mmediately (#167) With this change, the function terminates execution upon encountering a decoding error, providing more accurate error handling. This ensures that errors are not accumulated and allows the caller to handle the error appropriately. See: #195 (comment)

- when inputA and inputB have no common elements then return inputA as the result

- Refactor logger initialisation and document decoding to fail fast and return errors immediately - Enhanced empty doc check - Add comment to the function

didierofrivia

👍🏼

guicassolato

Excellent job, @art-tapin! Thank you! 🥇

* Build images with replaces image (#193) * [makefile] Updating the `replaces` directive in CSV * [gh workflow] Adding `replacesVersion` as input for workflow_dispatch * [config] Adding default replaces operator value * [bundle] Updated bundle * Building the catalog with the replaces directive (#194) * [catalog] Building the catalog with the replaces directive * [catalog] Setting default replaces version to `0.0.0-alpha` * [bundle] Updating config and bundle with new default release version * upgrade operator-sdk v1.28.1 * fix verify-bundle task * Create a ServiceMeshMember, rather than mutating the ServiceMeshMemberRoll * Fixed access to servicemeshmember * [test] Unit-tests for common/k8s_utils.go (part 2 of 3) (#191) * test: Add unit-tests to StatusConditionsMarshalJSON (#167) * test: Add unit-tests to IsOwnedBy (#167) * refactor: Add comment to IsOwnedBy (#167) * test: Add unit-test to GetServicePortNumber (#167) * Update gateway-api module to v0.6.2 (#153) * Update gateway api dep to v0.6.2 Update controller runtime Set go version 1.19 Use github.com/onsi/ginkgo/v2 which is used by the latest version if controller-runtime (envtest). * Update GatewayClass, Gateway and HTTPRoute to v1beta1 Since v0.6.0 GatewayClass, Gateway and HTTPRoute have moved to the v1beta1 version of the API and support in v1alpha2 will be removed eventually. All references to these APIS are now updated to use v1beta1. PolicyTargetReference are still v1alpha2. * [test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go (#195) * test: Add test-case to TestObjectKeyListDifference (#167) - when inputA and inputB have no common elements then return inputA as the result * refactor: Rename tests for ObjectKeyListDifference (#167) * test: Add unit-tests to ContainsObjectKey (#167) * test: Add unit-tests to FindObjectKey (#167) * test: Add unit-tests to FindDeploymentStatusCondition (#167) * refactor: Clarify test name in TestStatusConditionsMarshalJSON (#167) * test: Add unit-tests to DecodeFile (#167) * refactor, improvements: DecodeFile YAML decoder (#167) - Refactor logger initialisation and document decoding to fail fast and return errors immediately - Enhanced empty doc check - Add comment to the function --------- Co-authored-by: dd di cesare <[email protected]> Co-authored-by: Eguzki Astiz Lezaun <[email protected]> Co-authored-by: Alex Snaps <[email protected]> Co-authored-by: artem_tiupin <[email protected]> Co-authored-by: Michael Nairn <[email protected]>

* Build images with replaces image (#193) * [makefile] Updating the `replaces` directive in CSV * [gh workflow] Adding `replacesVersion` as input for workflow_dispatch * [config] Adding default replaces operator value * [bundle] Updated bundle * Building the catalog with the replaces directive (#194) * [catalog] Building the catalog with the replaces directive * [catalog] Setting default replaces version to `0.0.0-alpha` * [bundle] Updating config and bundle with new default release version * upgrade operator-sdk v1.28.1 * fix verify-bundle task * Create a ServiceMeshMember, rather than mutating the ServiceMeshMemberRoll * Fixed access to servicemeshmember * [test] Unit-tests for common/k8s_utils.go (part 2 of 3) (#191) * test: Add unit-tests to StatusConditionsMarshalJSON (#167) * test: Add unit-tests to IsOwnedBy (#167) * refactor: Add comment to IsOwnedBy (#167) * test: Add unit-test to GetServicePortNumber (#167) * Update gateway-api module to v0.6.2 (#153) * Update gateway api dep to v0.6.2 Update controller runtime Set go version 1.19 Use github.com/onsi/ginkgo/v2 which is used by the latest version if controller-runtime (envtest). * Update GatewayClass, Gateway and HTTPRoute to v1beta1 Since v0.6.0 GatewayClass, Gateway and HTTPRoute have moved to the v1beta1 version of the API and support in v1alpha2 will be removed eventually. All references to these APIS are now updated to use v1beta1. PolicyTargetReference are still v1alpha2. * [test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go (#195) * test: Add test-case to TestObjectKeyListDifference (#167) - when inputA and inputB have no common elements then return inputA as the result * refactor: Rename tests for ObjectKeyListDifference (#167) * test: Add unit-tests to ContainsObjectKey (#167) * test: Add unit-tests to FindObjectKey (#167) * test: Add unit-tests to FindDeploymentStatusCondition (#167) * refactor: Clarify test name in TestStatusConditionsMarshalJSON (#167) * test: Add unit-tests to DecodeFile (#167) * refactor, improvements: DecodeFile YAML decoder (#167) - Refactor logger initialisation and document decoding to fail fast and return errors immediately - Enhanced empty doc check - Add comment to the function * [istio] Updating registerIstioExternalAuthorizer * Reconciles also the Istio ConfigMap with the external authorizers * If the IstioOperator CR returns an error, it continues reconciling CM * [istio] Updating the unregisterExternalAuthorizerIstio * With the new functionality * [mesh config] Refactoring and testing mesh config functionality * [makefile] Splitting local deploy in different target * [istio] Refactoring using wrapper structs * [go] Fixing dependencies * [mesh config] Refactoring mesh config objects and fns * [controller] Fixing registering logic * Still relying on the istio CRD being installed. If not, means no istio * If it's 404, means it's installed other way than it's operator * If any other error happens, istio is installed, but an error occurred * [controller] Refactoring istio installation process * Added ENV for CM name * [refactor] Using apierrors.IsNotFound instead of crafting the error msg * kind: bump to 0.20.0 and pin image to kindest/node:v1.27.3 (#209) * Upgrade Authorino and Authorino Operator to latest (#211) * Authorino v0.14.0 * Authorino Operator v0.8.0 * workflow: use go1.19 to align with go.mod go version used (#213) * workflow: use go1.19 to align with go.mod go version used * doc: fix operator-sdk & kind versions used for development --------- Co-authored-by: dd di cesare <[email protected]> Co-authored-by: Eguzki Astiz Lezaun <[email protected]> Co-authored-by: Alex Snaps <[email protected]> Co-authored-by: artem_tiupin <[email protected]> Co-authored-by: Michael Nairn <[email protected]> Co-authored-by: dd di cesare <[email protected]> Co-authored-by: Kevin Fan <[email protected]>

* Build images with replaces image (Kuadrant#193) * [makefile] Updating the `replaces` directive in CSV * [gh workflow] Adding `replacesVersion` as input for workflow_dispatch * [config] Adding default replaces operator value * [bundle] Updated bundle * Building the catalog with the replaces directive (Kuadrant#194) * [catalog] Building the catalog with the replaces directive * [catalog] Setting default replaces version to `0.0.0-alpha` * [bundle] Updating config and bundle with new default release version * upgrade operator-sdk v1.28.1 * fix verify-bundle task * Create a ServiceMeshMember, rather than mutating the ServiceMeshMemberRoll * Fixed access to servicemeshmember * [test] Unit-tests for common/k8s_utils.go (part 2 of 3) (Kuadrant#191) * test: Add unit-tests to StatusConditionsMarshalJSON (Kuadrant#167) * test: Add unit-tests to IsOwnedBy (Kuadrant#167) * refactor: Add comment to IsOwnedBy (Kuadrant#167) * test: Add unit-test to GetServicePortNumber (Kuadrant#167) * Update gateway-api module to v0.6.2 (Kuadrant#153) * Update gateway api dep to v0.6.2 Update controller runtime Set go version 1.19 Use github.com/onsi/ginkgo/v2 which is used by the latest version if controller-runtime (envtest). * Update GatewayClass, Gateway and HTTPRoute to v1beta1 Since v0.6.0 GatewayClass, Gateway and HTTPRoute have moved to the v1beta1 version of the API and support in v1alpha2 will be removed eventually. All references to these APIS are now updated to use v1beta1. PolicyTargetReference are still v1alpha2. * [test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go (Kuadrant#195) * test: Add test-case to TestObjectKeyListDifference (Kuadrant#167) - when inputA and inputB have no common elements then return inputA as the result * refactor: Rename tests for ObjectKeyListDifference (Kuadrant#167) * test: Add unit-tests to ContainsObjectKey (Kuadrant#167) * test: Add unit-tests to FindObjectKey (Kuadrant#167) * test: Add unit-tests to FindDeploymentStatusCondition (Kuadrant#167) * refactor: Clarify test name in TestStatusConditionsMarshalJSON (Kuadrant#167) * test: Add unit-tests to DecodeFile (Kuadrant#167) * refactor, improvements: DecodeFile YAML decoder (Kuadrant#167) - Refactor logger initialisation and document decoding to fail fast and return errors immediately - Enhanced empty doc check - Add comment to the function --------- Co-authored-by: dd di cesare <[email protected]> Co-authored-by: Eguzki Astiz Lezaun <[email protected]> Co-authored-by: Alex Snaps <[email protected]> Co-authored-by: artem_tiupin <[email protected]> Co-authored-by: Michael Nairn <[email protected]>

art-tapin marked this pull request as ready for review May 29, 2023 20:10

art-tapin requested a review from a team as a code owner May 29, 2023 20:10

guicassolato reviewed May 30, 2023

View reviewed changes

pkg/common/yaml_decoder_test.go Outdated Show resolved Hide resolved

pkg/common/yaml_decoder_test.go Outdated Show resolved Hide resolved

guicassolato reviewed May 30, 2023

View reviewed changes

pkg/common/k8s_utils_test.go Show resolved Hide resolved

guicassolato reviewed May 30, 2023

View reviewed changes

pkg/common/k8s_utils_test.go Show resolved Hide resolved

guicassolato reviewed May 30, 2023

View reviewed changes

pkg/common/yaml_decoder_test.go Show resolved Hide resolved

didierofrivia reviewed Jun 2, 2023

View reviewed changes

pkg/common/yaml_decoder.go Outdated Show resolved Hide resolved

didierofrivia reviewed Jun 2, 2023

View reviewed changes

pkg/common/yaml_decoder.go Outdated Show resolved Hide resolved

art-tapin requested review from didierofrivia and guicassolato June 12, 2023 12:41

art-tapin added 8 commits June 15, 2023 13:42

test: Add test-case to TestObjectKeyListDifference (#167)

faaa727

- when inputA and inputB have no common elements then return inputA as the result

refactor: Rename tests for ObjectKeyListDifference (#167)

7ef33f8

test: Add unit-tests to ContainsObjectKey (#167)

fbb8dda

test: Add unit-tests to FindObjectKey (#167)

b0a4b42

test: Add unit-tests to FindDeploymentStatusCondition (#167)

48cc170

refactor: Clarify test name in TestStatusConditionsMarshalJSON (#167)

f0eeb4c

test: Add unit-tests to DecodeFile (#167)

aa18804

refactor, improvements: DecodeFile YAML decoder (#167)

f2d1ee1

- Refactor logger initialisation and document decoding to fail fast and return errors immediately - Enhanced empty doc check - Add comment to the function

art-tapin force-pushed the issue167/tests_for_k8s_utils-3 branch from 87bdaaf to f2d1ee1 Compare June 15, 2023 13:47

didierofrivia approved these changes Jun 19, 2023

View reviewed changes

guicassolato approved these changes Jun 20, 2023

View reviewed changes

art-tapin merged commit 3f21f81 into main Jun 21, 2023

art-tapin deleted the issue167/tests_for_k8s_utils-3 branch June 21, 2023 12:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go #195

[test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go #195

art-tapin commented May 29, 2023 •

edited

Loading

didierofrivia left a comment

guicassolato left a comment

[test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go #195

[test] Unit-tests for common/k8s_utils.go (part 3 of 3) & Unit-tests and improvements for common/yaml_decoder.go #195

Conversation

art-tapin commented May 29, 2023 • edited Loading

didierofrivia left a comment

Choose a reason for hiding this comment

guicassolato left a comment

Choose a reason for hiding this comment

art-tapin commented May 29, 2023 •

edited

Loading