woodpecker/cli/lint/lint.go

89 lines
2.2 KiB
Go
Raw Normal View History

// Copyright 2023 Woodpecker Authors
//
// 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
//
// http://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 lint
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/urfave/cli/v2"
"github.com/woodpecker-ci/woodpecker/cli/common"
"github.com/woodpecker-ci/woodpecker/pipeline/schema"
)
// Command exports the info command.
var Command = &cli.Command{
Name: "lint",
Usage: "lint a pipeline configuration file",
ArgsUsage: "[path/to/.woodpecker.yaml]",
Action: lint,
Flags: common.GlobalFlags,
}
func lint(c *cli.Context) error {
return common.RunPipelineFunc(c, lintFile, lintDir)
}
func lintDir(c *cli.Context, dir string) error {
var errorStrings []string
if err := filepath.Walk(dir, func(path string, info os.FileInfo, e error) error {
if e != nil {
return e
}
// check if it is a regular file (not dir)
if info.Mode().IsRegular() && (strings.HasSuffix(info.Name(), ".yaml") || strings.HasSuffix(info.Name(), ".yml")) {
fmt.Println("#", info.Name())
if err := lintFile(c, path); err != nil {
errorStrings = append(errorStrings, err.Error())
}
fmt.Println("")
return nil
}
return nil
}); err != nil {
return err
}
if len(errorStrings) != 0 {
return fmt.Errorf("ERRORS: %s", strings.Join(errorStrings, "; "))
}
return nil
}
func lintFile(_ *cli.Context, file string) error {
fi, err := os.Open(file)
if err != nil {
return err
}
defer fi.Close()
configErrors, err := schema.Lint(fi)
if err != nil {
fmt.Println("❌ Config is invalid")
for _, configError := range configErrors {
fmt.Println("In", configError.Field()+":", configError.Description())
}
return err
}
fmt.Println("✅ Config is valid")
return nil
}