airshipctl/pkg/phase/render.go
Kostiantyn Kalynovskyi 6807547ab2 Add ability to render different document sets
Now we would be able to render phase bundle, executor bundle
and config bundle. Config bundle will contain documents such as
phases and executors.

Relates-To: #459
Closes: #459

Change-Id: Ia6b9196dfb3d8fb3264fef676c975ccc32883fee
2021-02-04 17:40:35 +00:00

119 lines
3.3 KiB
Go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package phase
import (
"io"
"strings"
"opendev.org/airship/airshipctl/pkg/config"
"opendev.org/airship/airshipctl/pkg/document"
"opendev.org/airship/airshipctl/pkg/phase/ifc"
)
const (
// RenderSourceConfig will render a bundle that comes from site metadata file
// and contains phase and executor docs
RenderSourceConfig = "config"
// RenderSourceExecutor indicates that rendering will be delegated to phase executor
RenderSourceExecutor = "executor"
// RenderSourcePhase the source will use kustomize root at phase entry point
RenderSourcePhase = "phase"
)
// RenderCommand holds filters for selector
type RenderCommand struct {
// Label filters documents by label string
Label string
// Annotation filters documents by annotation string
Annotation string
// APIVersion filters documents by API group and version
APIVersion string
// Kind filters documents by document kind
Kind string
// Source identifies source of the bundle, these can be [phase|config|executor]
// phase the source will use kustomize root at phase entry point
// config will render a bundle that comes from site metadata file, and contains phase and executor docs
// executor means that rendering will be delegated to phase executor
Source string
PhaseID ifc.ID
}
// RunE prints out filtered documents
func (fo *RenderCommand) RunE(cfgFactory config.Factory, out io.Writer) error {
if err := fo.Validate(); err != nil {
return err
}
cfg, err := cfgFactory()
if err != nil {
return err
}
helper, err := NewHelper(cfg)
if err != nil {
return err
}
if fo.Source == RenderSourceConfig {
return renderConfigBundle(out, helper)
}
client := NewClient(helper)
phase, err := client.PhaseByID(fo.PhaseID)
if err != nil {
return err
}
groupVersion := strings.Split(fo.APIVersion, "/")
group := ""
version := groupVersion[0]
if len(groupVersion) > 1 {
group = groupVersion[0]
version = strings.Join(groupVersion[1:], "/")
}
sel := document.NewSelector().ByLabel(fo.Label).ByAnnotation(fo.Annotation).ByGvk(group, version, fo.Kind)
var executorRender bool
if fo.Source == RenderSourceExecutor {
executorRender = true
}
return phase.Render(out, executorRender, ifc.RenderOptions{FilterSelector: sel})
}
func renderConfigBundle(out io.Writer, h ifc.Helper) error {
bundle, err := document.NewBundleByPath(h.PhaseBundleRoot())
if err != nil {
return err
}
return bundle.Write(out)
}
// Validate checks if command options are valid
func (fo *RenderCommand) Validate() (err error) {
switch fo.Source {
case RenderSourceConfig:
// do nothing, source config doesnt need any parameters
case RenderSourceExecutor, RenderSourcePhase:
if fo.PhaseID.Name == "" {
err = ErrRenderPhaseNameNotSpecified{}
}
default:
err = ErrUknownRenderSource{Source: fo.Source}
}
return err
}