GoogleContainerTools/skaffold

Refactor code and remove duplication

Open

#7,318 opened on Apr 15, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
help wantedkind/starter-projectkind/todopriority/p3

Description

This task is about remove code duplication.

The skaffold filter command was added to apply debug transformations to configure container images for debugging. See here -> https://skaffold.dev/docs/workflows/debug/#configuring-container-images-for-debugging

When skaffold filter command was added it did not need any information from the run context.

However, after @aaron-prindle added the Resource Selector config where users can configure which resource types to transform. These list now needs to be passed to Filter command. In #7317, @tejal29 duplicated the functionality in getTransformList

The right way to do this is, Add Filter() method to the SkaffoldRunner which has access to the runner.RunContext.TransformAllowList and runCtx.runner.RunContext.TransformDenyList

The new Filter method will additionally execute the runFilter in here

Contributor guide

Tech stack
go
Domain
clidevopsinfrastructure
Issue type
refactor
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingskaffold codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The implementation requires adding a Filter() method to the SkaffoldRunner that uses TransformAllowList and TransformDenyList from runner.RunContext (see pkg/skaffold/runner/runcontext/context.go lines 111+). This method should execute the runFilter logic currently in cmd/skaffold/app/cmd/filter.go line 59. The duplicated getTransformList function in the filter command should be removed and replaced by calling the new Filter method. The existing test suite for filter should be updated to cover the new implementation.