kubernetes-sigs/cluster-api

Improve testing for Runtime SDK variable discovery

Open

#8,497 opened on Apr 6, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (1,532 forks)auto 404
area/runtime-sdkhelp wantedkind/cleanuppriority/important-longtermtriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

This is an umbrella issue to follow up on improvements to testing and documenting #7985

  • Add unit tests testing the variables returned from the test-extension
  • Add an end to end test that covers complex variables
  • Add an end to end test which covers moving from a set of inline variables and patches to external variables and patches
  • Use runtimeSDK settings in a runtime variable discovery and/or patch call
  • Add documentation on best practices for writing variable discovery extensions.

Contributor guide

Research direction
Review the existing test extension and variable discovery tests in the repository. Understand the structure of runtime variable discovery. Then implement the unit tests for variables returned from the test extension, followed by end to end tests for complex variables and inline to external variable migration. Refer to existing test examples in the project.
Tech stack
go
Domain
backend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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
GoTestingGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75