ContainerSolutions/externalsecret-operator

Increase our unit test coverage

Open

#103 opened on Oct 7, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (2 assignees)Go (27 forks)auto 404
enhancementgood first issuehacktoberfesthelp wantedtesting

Repository metrics

Stars
 (192 stars)
PR merge metrics
 (PR metrics pending)

Description

I am opening this issue as a general issue to attract hacktoberfestians, but we can later open sub-issues to be more specific on what types of testes and where we want them.

Generally we want tests for our main controller (responsible for our reconciliation loop) or/and our backends (responsible for implementing our interface to external secrets solutions support).

Example:

This is the Google Secrets Manager Backend implementation: pkg/gsm/backend.go

This is where its tests are implemented: pkg/gsm/backend_test.go

Our controller logic: controllers/secrets/externalsecret_controller.go

Its tests: controllers/secrets/externalsecret_controller_test.go

I will try to add a checklist here later. But generally if you implement a meaningful test in these places they will be welcomed.

You can also checkout codecov to see where we have less coverage to bump it up a bit.

Contributor guide

Research direction
Write unit tests for the main controller (controllers/secrets/externalsecret controller.go) and/or backends (e.g., pkg/gsm/backend.go). Reference existing tests in externalsecret controller test.go and backend test.go. Use codecov to identify low coverage areas.
Tech stack
gokubernetes
Domain
backendinfrastructurecloud
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gotesting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70