Add base unit test suite for repository server controller(#PR1) #2100

kale-amruta · 2023-06-13T07:54:08Z

Change Overview

PR1 adds the base suite for adding unit tests for repository server controller

It adds setupSuite tearDownSuite , ant util functions that are required to run the suite

PR2 adds unit tests for testing following functionality of repository server controller

Check if Server is created successfully and CR is in RepositoryServerReady after all the configurations are done correctly
Check if Server goes into RepositoryServerStopped state when secrets are not provided in CR
Immutability of certain fields in the CR - update of CR for certain fields should not be allowed
Check if repository server pod and service are getting created after creating the CR
Check Repository Connect failures if the secrets are configured incorrectly
Check what cachesizesettings are passed to kopia when the CR is configured with cachesizesettings field
Test fetching of repository server secrets in the controller

Pull request type

Please check the type of change your PR introduces:

Issues

fixes #issue-number

Test Plan

💪 Manual
⚡ Unit test
💚 E2E

github-actions · 2023-06-13T07:54:21Z

Thanks for submitting this pull request 🎉. The team will review it soon and get back to you.

If you haven't already, please take a moment to review our project contributing guideline and Code of Conduct document.

viveksinghggits · 2023-06-15T11:10:04Z

@kale-amruta can you please add test plan in this PR and and the things that are being tested in the PR desc.

ankitjain235

Added some minor suggestions, looks good otherwise.

pkg/controllers/repositoryserver/suite_test.go

viveksinghggits

looks almost good to me 😆

pkg/controllers/repositoryserver/suite_test.go

pkg/controllers/repositoryserver/testutils.go

pkg/testutil/testutil.go

pkg/controllers/repositoryserver/repositoryserver_controller_test.go

…to baseUnitTestSuite

* add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * address review comments * move test utilities to pkg/testutil/testutil.go * rename kopia repository path constant name * move constants to const.go * move constants to const.go * initialize reconciler in a better way

* add skeleton for validation repoitory server secrets * fix bugs * add licence headers * address review comments * change the secret type to v1.secrettype * initialize k8s client instead of all the clients since they are not required * move the consts to a secrets package so that they can be reused * move the consts to a secrets package so that they can be reused * refactor to use common constants * move the consts to a secrets package so that they can be reused * refactor to use the constants from secrets folder * address review comments * add headers * address review comments * move location key constants to secrets package * move location key constants to repositoryserver package * refactor use the constants from repositoryserver package * resolve merge conflicts * address review comments * add support for filestore secret * make lint happy * address comments * make lint happy * add licence headers * add comments on the constants * consistent error messages * Change name of constants for better readability * fix typo * simplify validation logic * change error message * remove unwanted comments * add comment in the validate repository password function * change function name for getLocationType to getLocationSecret * add nil checks for secrets * fix build issues * add empty secret checks * rename interface name to secret for readability * address review comments * address review comments * use cmd.Context * Add Cache Size Support in Templating Params in RepositoryServer (#2111) * Update param.go Signed-off-by: Rajat Gupta <rajat.gupta@veeam.com> * Address Comments Signed-off-by: Rajat Gupta <rajat.gupta@veeam.com> * Error Handling Signed-off-by: Rajat Gupta <rajat.gupta@veeam.com> --------- Signed-off-by: Rajat Gupta <rajat.gupta@veeam.com> * Make RepositoryServer struct consistent with RepositoryServer CRD (#2122) * Remove optional Markers, Add omitempty to fields in RepositoryServer struct as specified in repositoryserver.yaml Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Fix the indentation of repositoryserver CRD(repositoryserver.yaml) Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> --------- Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * add unit tests for repository server location credentials * make lint happy * add validation for kopia repository server controller secrets (#1940) * add skeleton for validation repoitory server secrets * fix bugs * add licence headers * address review comments * change the secret type to v1.secrettype * initialize k8s client instead of all the clients since they are not required * move the consts to a secrets package so that they can be reused * move the consts to a secrets package so that they can be reused * refactor to use common constants * move the consts to a secrets package so that they can be reused * refactor to use the constants from secrets folder * address review comments * add headers * address review comments * move location key constants to secrets package * move location key constants to repositoryserver package * refactor use the constants from repositoryserver package * resolve merge conflicts * address review comments * add support for filestore secret * make lint happy * address comments * make lint happy * add licence headers * add comments on the constants * consistent error messages * Change name of constants for better readability * fix typo * simplify validation logic * change error message * remove unwanted comments * add comment in the validate repository password function * change function name for getLocationType to getLocationSecret * add nil checks for secrets * fix build issues * add empty secret checks * rename interface name to secret for readability * address review comments * address review comments * use cmd.Context * Update MAINTAINERS.md (#2127) * support projectid in gcp provider (#2129) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * fix delete action (#2131) * Import the general client/auth package (#2134) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Fix pkg/config to use standard kubeconfig machinery (#2133) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Fix pkg/kube to use standard kubeconfig machinery (#2132) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Update ubi-minimal base image to ubi-minimal:9.2-691 (#2130) Co-authored-by: Kasten Production <infra@kasten.io> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * add tests for validating repository password and repository server admin credentials * fix tests * fix lint * fix e2e volume snapshot test (#2141) * Remove unused dirs to increase free space in GH runner (#2138) * Refactoring push_images.sh to consume a single source of truth containing valid images (#2147) * Refactoring push_images.sh to take in the single source of truth Made change * Added single source of truth file * Fixing issue with image list * Update RepositoryServer CR Status field to add `metav1.Condition` (#2135) * Update RepositoryServer CR Status fields, add metav1.conditions Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Update RepositoryServer CRD Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Run 'make codegen' Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Fix Lint Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Refactor name, set ClientInitialized to ClientUserInitialized Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> --------- Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Add: ROADMAP.md (#2126) * Add: ROADMAP.md Signed-off-by: Mark <mlavi@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> * Update ROADMAP.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> --------- Signed-off-by: Mark <mlavi@users.noreply.github.com> Co-authored-by: Mark <mlavi@users.noreply.github.com> Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Kanister docs update to version 0.93.0 (#2149) Co-authored-by: Kasten Production <infra@kasten.io> * Refactor RepositoryServer controller (#2136) * Update RepositoryServer CR Status fields, add metav1.conditions Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Update RepositoryServer CRD Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Run 'make codegen' Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Fix Lint Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Refactor name, set ClientInitialized to ClientUserInitialized Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Refactor RepositoryServer Controller Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Run gofmt Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * add error handling in refreshServer function Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> * Add function to update Progress in RepositoryServerStatus Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> --------- Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> Co-authored-by: kale-amruta <41624751+kale-amruta@users.noreply.github.com> * Revert "Refactor RepositoryServer controller (#2136)" (#2150) This reverts commit fb4bd07. * Add base unit test suite for repository server controller(#PR1) (#2100) * add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * add base suite for repository server controller * use constants for location secret keys * make the constants local to the package * add licence headers * fix licence headers * fix lint issues * remove unused functions and move to next PR * fix build issues * move secret creation utils under test suite * address review comments * move test utilities to pkg/testutil/testutil.go * rename kopia repository path constant name * move constants to const.go * move constants to const.go * initialize reconciler in a better way * Run PostgreSQL integration tests on 12.6.0 chart (#2156) Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com> * Adjust ref apps for OCP 4.13 (#2152) Kanister test automation config for OCP 4.13 version Co-authored-by: Vladislav Naumov <vladislav.naumov@PRG10457-MacBook-Pro.local> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * deps(go): bump google.golang.org/api from 0.120.0 to 0.130.0 (#2157) Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.120.0 to 0.130.0. - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](googleapis/google-api-go-client@v0.120.0...v0.130.0) --- updated-dependencies: - dependency-name: google.golang.org/api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps(go): bump golang.org/x/oauth2 from 0.7.0 to 0.10.0 (#2158) Bumps [golang.org/x/oauth2](https://github.com/golang/oauth2) from 0.7.0 to 0.10.0. - [Commits](golang/oauth2@v0.7.0...v0.10.0) --- updated-dependencies: - dependency-name: golang.org/x/oauth2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * remove unwanted declaration of context variable --------- Signed-off-by: Rajat Gupta <rajat.gupta@veeam.com> Signed-off-by: Akanksha Kumari <akankshakumari393@gmail.com> Signed-off-by: Mark <mlavi@users.noreply.github.com> Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Rajat Gupta <37516416+r4rajat@users.noreply.github.com> Co-authored-by: Akanksha kumari <akankshakumari393@gmail.com> Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> Co-authored-by: alexy.bee <alexey.blokhin@kasten.io> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Mark Severson <mark@kasten.io> Co-authored-by: Infra Bot <63741182+infraq@users.noreply.github.com> Co-authored-by: Kasten Production <infra@kasten.io> Co-authored-by: Nishant Ravi Shankar <23146332+mellon-collie@users.noreply.github.com> Co-authored-by: Mark Lavi <5642075+mlavi@users.noreply.github.com> Co-authored-by: Mark <mlavi@users.noreply.github.com> Co-authored-by: Prasad Ghangal <prasad.ghangal@gmail.com> Co-authored-by: Vladislav Naumov <vladislav.naumov@kasten.io> Co-authored-by: Vladislav Naumov <vladislav.naumov@PRG10457-MacBook-Pro.local> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

add base suite for repository server controller

ac3f85d

infraq added this to In Progress in Kanister Jun 13, 2023

kale-amruta requested review from ankitjain235 and removed request for ankitjain235 June 13, 2023 07:55

kale-amruta and others added 7 commits June 13, 2023 13:25

Merge branch 'master' into baseUnitTestSuite

a3f43dc

use constants for location secret keys

4229e5b

make the constants local to the package

dd537d6

add licence headers

5798aaa

fix licence headers

28a42c8

fix lint issues

ce4aa08

remove unused functions and move to next PR

752d40a

kale-amruta force-pushed the baseUnitTestSuite branch from 4e9e4a8 to 752d40a Compare June 14, 2023 06:19

Merge branch 'master' into baseUnitTestSuite

b1afaea

kale-amruta requested review from pavannd1, ankitjain235 and viveksinghggits June 14, 2023 06:23

kale-amruta mentioned this pull request Jun 16, 2023

Add unit tests for kopia repository server controller(PR #2) #1997

Merged

10 tasks

kale-amruta added 2 commits June 16, 2023 13:02

Merge branch 'master' into baseUnitTestSuite

3717b57

Merge branch 'master' into baseUnitTestSuite

3e11645

ankitjain235 reviewed Jun 22, 2023

View reviewed changes

kale-amruta and others added 5 commits June 23, 2023 12:24

Merge branch 'master' into baseUnitTestSuite

29319ac

Merge branch 'master' into baseUnitTestSuite

ed1b482

fix build issues

63d231f

move secret creation utils under test suite

8d92463

Merge branch 'master' into baseUnitTestSuite

ed38cf6

viveksinghggits reviewed Jun 26, 2023

View reviewed changes

pkg/controllers/repositoryserver/suite_test.go Outdated Show resolved Hide resolved

pkg/controllers/repositoryserver/testutils.go Outdated Show resolved Hide resolved

pkg/testutil/testutil.go Show resolved Hide resolved

kale-amruta and others added 2 commits June 28, 2023 12:48

Merge branch 'master' into baseUnitTestSuite

7a20c05

add base suite for repository server controller

28aca4a

kale-amruta and others added 7 commits June 29, 2023 11:11

fix licence headers

56520d3

fix lint issues

1aa95f7

remove unused functions and move to next PR

ac44d85

fix build issues

4cdb906

move secret creation utils under test suite

40f57ee

address review comments

566fa61

Merge branch 'master' into baseUnitTestSuite

7de1333

kale-amruta requested a review from viveksinghggits June 29, 2023 05:48

rename the test file

f04483e

kale-amruta force-pushed the baseUnitTestSuite branch from bc4289d to f04483e Compare June 29, 2023 05:50

viveksinghggits reviewed Jun 30, 2023

View reviewed changes

pkg/controllers/repositoryserver/repositoryserver_controller_test.go Outdated Show resolved Hide resolved

pkg/controllers/repositoryserver/repositoryserver_controller_test.go Outdated Show resolved Hide resolved

move test utilities to pkg/testutil/testutil.go

0cba539

kale-amruta force-pushed the baseUnitTestSuite branch from 51deb83 to 0cba539 Compare July 4, 2023 06:19

kale-amruta and others added 2 commits July 4, 2023 11:49

Merge branch 'master' into baseUnitTestSuite

bc56d8b

rename kopia repository path constant name

22e217b

viveksinghggits reviewed Jul 4, 2023

View reviewed changes

pkg/controllers/repositoryserver/repositoryserver_controller_test.go Outdated Show resolved Hide resolved

viveksinghggits approved these changes Jul 4, 2023

View reviewed changes

Kanister automation moved this from In Progress to Reviewer approved Jul 4, 2023

kale-amruta added 4 commits July 4, 2023 12:55

move constants to const.go

6f78746

move constants to const.go

56626d4

Merge branch 'baseUnitTestSuite' of github.com:kanisterio/kanister in…

101c714

…to baseUnitTestSuite

initialize reconciler in a better way

f8f2f4a

kale-amruta added the kueue label Jul 4, 2023

mergify bot merged commit 3d13005 into master Jul 4, 2023
14 checks passed

Kanister automation moved this from Reviewer approved to Done Jul 4, 2023

mergify bot deleted the baseUnitTestSuite branch July 4, 2023 09:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add base unit test suite for repository server controller(#PR1) #2100

Add base unit test suite for repository server controller(#PR1) #2100

kale-amruta commented Jun 13, 2023 •

edited

Loading

github-actions bot commented Jun 13, 2023

viveksinghggits commented Jun 15, 2023

ankitjain235 left a comment

viveksinghggits left a comment

Add base unit test suite for repository server controller(#PR1) #2100

Add base unit test suite for repository server controller(#PR1) #2100

Conversation

kale-amruta commented Jun 13, 2023 • edited Loading

Change Overview

Pull request type

Issues

Test Plan

github-actions bot commented Jun 13, 2023

viveksinghggits commented Jun 15, 2023

ankitjain235 left a comment

Choose a reason for hiding this comment

viveksinghggits left a comment

Choose a reason for hiding this comment

kale-amruta commented Jun 13, 2023 •

edited

Loading