github/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-10-22 02:12:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move cmd/common to shared (#3092)

Browse Source
This commit is contained in:
qwerty287
2023-12-31 23:29:56 +01:00
committed by GitHub
parent 4b977ab488
commit 0c05c38ddd
9 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
cmd/agent/agent.go
View File

@@ -39,18 +39,18 @@ import (
"go.woodpecker-ci.org/woodpecker/v2/agent"
agentRpc "go.woodpecker-ci.org/woodpecker/v2/agent/rpc"
"go.woodpecker-ci.org/woodpecker/v2/cmd/common"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend/types"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/rpc"
"go.woodpecker-ci.org/woodpecker/v2/shared/addon"
addonTypes "go.woodpecker-ci.org/woodpecker/v2/shared/addon/types"
"go.woodpecker-ci.org/woodpecker/v2/shared/logger"
"go.woodpecker-ci.org/woodpecker/v2/shared/utils"
"go.woodpecker-ci.org/woodpecker/v2/version"
)
func run(c *cli.Context) error {
common.SetupGlobalLogger(c, true)
logger.SetupGlobalLogger(c, true)
agentConfigPath := c.String("agent-config")
hostname := c.String("hostname")

4
cmd/agent/main.go
View File

@@ -21,10 +21,10 @@ import (
_ "github.com/joho/godotenv/autoload"
"github.com/urfave/cli/v2"
"go.woodpecker-ci.org/woodpecker/v2/cmd/common"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend/docker"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend/kubernetes"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/backend/local"
"go.woodpecker-ci.org/woodpecker/v2/shared/logger"
"go.woodpecker-ci.org/woodpecker/v2/shared/utils"
"go.woodpecker-ci.org/woodpecker/v2/version"
)
@@ -42,7 +42,7 @@ func main() {
Action: pinger,
},
}
app.Flags = utils.MergeSlices(flags, common.GlobalLoggerFlags, docker.Flags, kubernetes.Flags, local.Flags)
app.Flags = utils.MergeSlices(flags, logger.GlobalLoggerFlags, docker.Flags, kubernetes.Flags, local.Flags)
if err := app.Run(os.Args); err != nil {
fmt.Fprintln(os.Stderr, err)

26
cmd/common/common.go
View File

@@ -1,26 +0,0 @@
// 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 common
import (
"os"
"golang.org/x/term"
)
// IsInteractive checks if the output is piped, but NOT if the session is run interactively.
func IsInteractive() bool {
return term.IsTerminal(int(os.Stdout.Fd()))
}

102
cmd/common/logger.go
View File

@@ -1,102 +0,0 @@
// 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 common
import (
"io"
"os"
"github.com/6543/logfile-open"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/urfave/cli/v2"
)
var GlobalLoggerFlags = []cli.Flag{
&cli.StringFlag{
EnvVars: []string{"WOODPECKER_LOG_LEVEL"},
Name: "log-level",
Usage: "set logging level",
Value: "info",
},
&cli.StringFlag{
EnvVars: []string{"WOODPECKER_LOG_FILE"},
Name: "log-file",
Usage: "Output destination for logs. 'stdout' and 'stderr' can be used as special keywords.",
Value: "stderr",
},
&cli.BoolFlag{
EnvVars: []string{"WOODPECKER_DEBUG_PRETTY"},
Name: "pretty",
Usage: "enable pretty-printed debug output",
Value: IsInteractive(), // make pretty on interactive terminal by default
},
&cli.BoolFlag{
EnvVars: []string{"WOODPECKER_DEBUG_NOCOLOR"},
Name: "nocolor",
Usage: "disable colored debug output, only has effect if pretty output is set too",
Value: !IsInteractive(), // do color on interactive terminal by default
},
}
func SetupGlobalLogger(c *cli.Context, printLvl bool) {
logLevel := c.String("log-level")
pretty := c.Bool("pretty")
noColor := c.Bool("nocolor")
logFile := c.String("log-file")
var file io.ReadWriteCloser
switch logFile {
case "", "stderr": // default case
file = os.Stderr
case "stdout":
file = os.Stdout
default: // a file was set
openFile, err := logfile.OpenFileWithContext(c.Context, logFile, 0o660)
if err != nil {
log.Fatal().Err(err).Msgf("could not open log file '%s'", logFile)
}
file = openFile
noColor = true
}
log.Logger = zerolog.New(file).With().Timestamp().Logger()
if pretty {
log.Logger = log.Output(
zerolog.ConsoleWriter{
Out: file,
NoColor: noColor,
},
)
}
// TODO: format output & options to switch to json aka. option to add channels to send logs to
lvl, err := zerolog.ParseLevel(logLevel)
if err != nil {
log.Fatal().Msgf("unknown logging level: %s", logLevel)
}
zerolog.SetGlobalLevel(lvl)
// if debug or trace also log the caller
if zerolog.GlobalLevel() <= zerolog.DebugLevel {
log.Logger = log.With().Caller().Logger()
}
if printLvl {
log.Info().Msgf("LogLevel = %s", zerolog.GlobalLevel().String())
}
}

4
cmd/server/flags.go
View File

@@ -20,8 +20,8 @@ import (
"github.com/urfave/cli/v2"
"go.woodpecker-ci.org/woodpecker/v2/cmd/common"
"go.woodpecker-ci.org/woodpecker/v2/shared/constant"
"go.woodpecker-ci.org/woodpecker/v2/shared/logger"
)
var flags = append([]cli.Flag{
@@ -472,4 +472,4 @@ var flags = append([]cli.Flag{
Name: "encryption-disable-flag",
Usage: "Flag to decrypt all encrypted data and disable encryption on server",
},
}, common.GlobalLoggerFlags...)
}, logger.GlobalLoggerFlags...)

4
cmd/server/server.go
View File

@@ -34,7 +34,6 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/keepalive"
"go.woodpecker-ci.org/woodpecker/v2/cmd/common"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/rpc/proto"
"go.woodpecker-ci.org/woodpecker/v2/server"
"go.woodpecker-ci.org/woodpecker/v2/server/cron"
@@ -49,13 +48,14 @@ import (
"go.woodpecker-ci.org/woodpecker/v2/server/store"
"go.woodpecker-ci.org/woodpecker/v2/server/web"
"go.woodpecker-ci.org/woodpecker/v2/shared/constant"
"go.woodpecker-ci.org/woodpecker/v2/shared/logger"
"go.woodpecker-ci.org/woodpecker/v2/version"
// "go.woodpecker-ci.org/woodpecker/v2/server/plugins/encryption"
// encryptedStore "go.woodpecker-ci.org/woodpecker/v2/server/plugins/encryption/wrapper/store"
)
func run(c *cli.Context) error {
common.SetupGlobalLogger(c, true)
logger.SetupGlobalLogger(c, true)
// set gin mode based on log level
if zerolog.GlobalLevel() > zerolog.DebugLevel {