2023-08-10 09:06:00 +00:00
|
|
|
// 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.
|
|
|
|
|
2021-09-27 00:38:15 +00:00
|
|
|
package lint
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"os"
|
|
|
|
"path/filepath"
|
|
|
|
"strings"
|
|
|
|
|
2021-10-27 19:03:14 +00:00
|
|
|
"github.com/urfave/cli/v2"
|
2021-10-12 07:25:13 +00:00
|
|
|
|
2021-10-27 19:03:14 +00:00
|
|
|
"github.com/woodpecker-ci/woodpecker/cli/common"
|
2021-09-27 00:38:15 +00:00
|
|
|
"github.com/woodpecker-ci/woodpecker/pipeline/schema"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Command exports the info command.
|
2021-10-27 19:03:14 +00:00
|
|
|
var Command = &cli.Command{
|
2021-09-27 00:38:15 +00:00
|
|
|
Name: "lint",
|
|
|
|
Usage: "lint a pipeline configuration file",
|
2023-04-29 08:12:36 +00:00
|
|
|
ArgsUsage: "[path/to/.woodpecker.yaml]",
|
2021-09-27 00:38:15 +00:00
|
|
|
Action: lint,
|
2021-10-27 19:03:14 +00:00
|
|
|
Flags: common.GlobalFlags,
|
2021-09-27 00:38:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func lint(c *cli.Context) error {
|
2021-12-13 18:51:53 +00:00
|
|
|
return common.RunPipelineFunc(c, lintFile, lintDir)
|
|
|
|
}
|
2021-09-27 00:38:15 +00:00
|
|
|
|
2021-12-13 18:51:53 +00:00
|
|
|
func lintDir(c *cli.Context, dir string) error {
|
2022-07-17 16:25:56 +00:00
|
|
|
var errorStrings []string
|
|
|
|
if err := filepath.Walk(dir, func(path string, info os.FileInfo, e error) error {
|
2021-09-27 00:38:15 +00:00
|
|
|
if e != nil {
|
|
|
|
return e
|
|
|
|
}
|
|
|
|
|
|
|
|
// check if it is a regular file (not dir)
|
2023-04-29 08:12:36 +00:00
|
|
|
if info.Mode().IsRegular() && (strings.HasSuffix(info.Name(), ".yaml") || strings.HasSuffix(info.Name(), ".yml")) {
|
2021-09-27 00:38:15 +00:00
|
|
|
fmt.Println("#", info.Name())
|
2022-07-17 16:25:56 +00:00
|
|
|
if err := lintFile(c, path); err != nil {
|
|
|
|
errorStrings = append(errorStrings, err.Error())
|
|
|
|
}
|
2021-09-27 00:38:15 +00:00
|
|
|
fmt.Println("")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
2022-07-17 16:25:56 +00:00
|
|
|
}); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(errorStrings) != 0 {
|
|
|
|
return fmt.Errorf("ERRORS: %s", strings.Join(errorStrings, "; "))
|
|
|
|
}
|
|
|
|
return nil
|
2021-09-27 00:38:15 +00:00
|
|
|
}
|
|
|
|
|
2021-12-13 18:51:53 +00:00
|
|
|
func lintFile(_ *cli.Context, file string) error {
|
2022-04-19 08:40:48 +00:00
|
|
|
fi, err := os.Open(file)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer fi.Close()
|
|
|
|
|
|
|
|
configErrors, err := schema.Lint(fi)
|
2021-09-27 00:38:15 +00:00
|
|
|
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
|
|
|
|
}
|