Skip to content

Fix logging from low level operations #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion cli/compile/compile.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ func NewCommand() *cobra.Command {
"List of custom build properties separated by commas. Or can be used multiple times for multiple properties.")
command.Flags().StringVar(&warnings, "warnings", "none",
`Optional, can be "none", "default", "more" and "all". Defaults to "none". Used to tell gcc which warning level to use (-W flag).`)
command.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
command.Flags().BoolVar(&quiet, "quiet", false, "Optional, supresses almost every output.")
command.Flags().BoolVarP(&uploadAfterCompile, "upload", "u", false, "Upload the binary after the compilation.")
command.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
Expand Down
3 changes: 1 addition & 2 deletions commands/compile/compile.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import (
"github.com/arduino/arduino-cli/commands"
"github.com/arduino/arduino-cli/configs"
"github.com/arduino/arduino-cli/legacy/builder"
"github.com/arduino/arduino-cli/legacy/builder/i18n"
"github.com/arduino/arduino-cli/legacy/builder/types"
rpc "github.com/arduino/arduino-cli/rpc/commands"
paths "github.com/arduino/go-paths-helper"
Expand Down Expand Up @@ -159,7 +158,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W

builderCtx.ExecStdout = outStream
builderCtx.ExecStderr = errStream
builderCtx.SetLogger(i18n.LoggerToCustomStreams{Stdout: outStream, Stderr: errStream})
builderCtx.SetLogger(commands.LegacyLogger{})

// if --preprocess or --show-properties were passed, we can stop here
if req.GetShowProperties() {
Expand Down
78 changes: 78 additions & 0 deletions commands/legacy_logger.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// This file is part of arduino-cli.
//
// Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to modify or
// otherwise use the software for commercial activities involving the Arduino
// software without disclosing the source code of your own applications. To purchase
// a commercial license, send an email to [email protected].

package commands

import (
"fmt"
"io"

"github.com/arduino/arduino-cli/legacy/builder/constants"
"github.com/arduino/arduino-cli/legacy/builder/i18n"
"github.com/sirupsen/logrus"
)

// LegacyLogger wraps logrus but can be used within the `legacy` package
type LegacyLogger struct{}

// Fprintln is supposed to let the caller decide the target, let's not do it
// and just forward to Println
func (l LegacyLogger) Fprintln(w io.Writer, level string, format string, a ...interface{}) {
l.Println(level, format, a...)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this will create some regressions because the parameter w must be considered to redirect the output to the correct stream... the legacy i18n module is really a mess, let's have a call to plan a way to migrate to a saner logging infra.

}

// Println is a regular log call
func (l LegacyLogger) Println(level string, format string, a ...interface{}) {
msg := legacyFormat(format, a...)

switch level {
case constants.LOG_LEVEL_INFO:
logrus.Info(msg)
case constants.LOG_LEVEL_DEBUG:
logrus.Debug(msg)
case constants.LOG_LEVEL_ERROR:
logrus.Error(msg)
case constants.LOG_LEVEL_WARN:
logrus.Warn(msg)
default:
logrus.Trace(msg)
}
}

// UnformattedFprintln will do the same as Fprintln
func (l LegacyLogger) UnformattedFprintln(w io.Writer, str string) {
l.Println(constants.LOG_LEVEL_INFO, str)
}

// UnformattedWrite will do the same as Fprintln
func (l LegacyLogger) UnformattedWrite(w io.Writer, data []byte) {
l.Println(constants.LOG_LEVEL_INFO, string(data))
}

// Flush is a noop
func (l LegacyLogger) Flush() string {
return ""
}

// Name doesn't matter
func (l LegacyLogger) Name() string {
return "legacy"
}

func legacyFormat(format string, a ...interface{}) string {
format = i18n.FromJavaToGoSyntax(format)
message := fmt.Sprintf(format, a...)
return message
}