Console display refactoring

.gitignore

@@ -2,4 +2,5 @@ morserino_display
 dist/*
 notes/help.txt
 cover.out
-coverage.txt
+coverage.txt
+*.log

cmd/console.go

@@ -22,28 +22,33 @@ THE SOFTWARE.
 package cmd
 
 import (
-	"github.com/on4kjm/morserino_display/pkg/morserino_core"
+	"fmt"
+	"os"
+
+	"github.com/on4kjm/morserino_display/pkg/morserino"
 	"github.com/spf13/cobra"
 )
 
 // consoleCmd represents the console command
 var consoleCmd = &cobra.Command{
 	Use:   "console",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Short: "Displays the Morserino output to the console",
 	Run: func(cmd *cobra.Command, args []string) {
-		morserino_core.Morserino_console(morserinoPortName)
+		err := morserino.SetupLogger(morserinoDebugLevel, morserinoDebugFilename)
+		if err != nil {
+			fmt.Println("\nERROR:  " + err.Error() + "\n")
+			cmd.Help()
+			os.Exit(1)
+		}
+		morserino.Morserino_console(morserinoPortName)
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(consoleCmd)
 
+	//FIXME: the port parameter should be moved here
+
 	// Here you will define your flags and configuration settings.
 
 	// Cobra supports Persistent Flags which will work for this command

cmd/list.go

@@ -22,7 +22,10 @@ THE SOFTWARE.
 package cmd
 
 import (
-	"github.com/on4kjm/morserino_display/pkg/morserino_core"
+	"fmt"
+	"os"
+
+	"github.com/on4kjm/morserino_display/pkg/morserino"
 
 	"github.com/spf13/cobra"
 )
@@ -34,7 +37,13 @@ var listCmd = &cobra.Command{
 	Long: `Displays the ports available on the system.
 	`,
 	Run: func(cmd *cobra.Command, args []string) {
-		morserino_core.Morserino_list()
+		err := morserino.SetupLogger(morserinoDebugLevel, morserinoDebugFilename)
+		if err != nil {
+			fmt.Println("\nERROR:  " + err.Error() + "\n")
+			cmd.Help()
+			os.Exit(1)
+		}
+		morserino.Morserino_list()
 	},
 }
 

cmd/root.go

@@ -37,6 +37,12 @@ var cfgFile string
 //Global variable with the port name
 var morserinoPortName string
 
+//Global variable with the debug level
+var morserinoDebugLevel string
+
+//Global variable with the name of the log file (if defined)
+var morserinoDebugFilename string
+
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "morserino_display",
@@ -51,7 +57,7 @@ For easy reading, a new line is inserted after a "=" sign.
 	// Run: func(cmd *cobra.Command, args []string) { },
 	// Run: func(cmd *cobra.Command, args []string) {
 	// 	//Displaying on console is de default behaviour
-	// 	morserino_com.ConsoleListen(morserinoPortName)
+	// 	morserino_com.Listen(morserinoPortName)
 	// },
 }
 
@@ -69,12 +75,11 @@ func init() {
 	// will be global for your application.
 
 	rootCmd.PersistentFlags().StringVar(&morserinoPortName, "port", "auto", "Morserino port (if set to \"auto\", will try to identify the port)")
+	rootCmd.PersistentFlags().StringVar(&morserinoDebugLevel, "debug", "", "Activtes debug tracing and its level (\"info\", \"debug\", \"trace\")")
+	rootCmd.PersistentFlags().StringVar(&morserinoDebugFilename, "logfile", "", "Specifices a specific filename to collect the debug info (\"stdout\" is a valid filename")
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.morserino_display.yaml)")
 
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }
 
 // initConfig reads in config file and ENV variables if set.

go.mod

@@ -4,9 +4,11 @@ go 1.16
 
 require (
 	github.com/mitchellh/go-homedir v1.1.0
+	github.com/rs/zerolog v1.23.0
 	github.com/spf13/cobra v1.1.3
-	github.com/spf13/viper v1.7.1
+	github.com/spf13/viper v1.8.0
 	github.com/stretchr/testify v1.7.0
+	github.com/tidwall/gjson v1.8.0
 	go.bug.st/serial v1.1.3
-	golang.org/x/sys v0.0.0-20200909081042-eff7692f9009
+	golang.org/x/sys v0.0.0-20210616094352-59db8d763f22
 )

notes/notes.md

@@ -61,5 +61,21 @@ See also [Create a CLI in golang with Cobra](https://codesource.io/create-a-cli-
 * [Think Differently About What to Log in Go: Best Practices Examined](https://www.loggly.com/blog/think-differently-about-what-to-log-in-go-best-practices-examined/)
 * [How to Design a Basic Logging System in Your Go Application](https://betterprogramming.pub/understanding-and-designing-logging-system-in-go-application-c85a28bb8526)
 
+## Go Routines and channels
+### Stopping
+* [Stopping Goroutines](https://medium.com/@matryer/stopping-goroutines-golang-1bf28799c1cb), 2015
+* [How to kill execution of goroutine?](https://www.golangprograms.com/how-to-kill-execution-of-goroutine.html)
+* [Go - graceful shutdown of worker goroutines](https://callistaenterprise.se/blogg/teknik/2019/10/05/go-worker-cancellation/), 2019
+* [Stopping goroutines](https://riptutorial.com/go/example/6055/stopping-goroutines)
+* [Never start a goroutine without knowing how it will stop](https://dave.cheney.net/2016/12/22/never-start-a-goroutine-without-knowing-how-it-will-stop), Dave Cheney, 2016
+
+### Channels and error handling
+* ["Goroutines Error Handling"](https://www.atatus.com/blog/goroutines-error-handling/), blog, 2015
+* ["Go Concurrency Patterns: Pipelines and cancellation"](https://blog.golang.org/pipelines), blog.golang.org, 2014
+* ["Pipeline Patterns in Go: Pipelines with Error-handling and Cancellation"](https://medium.com/statuscode/pipeline-patterns-in-go-a37bb3a7e61d), medium, 2017
+* ["Idiomatic goroutine termination and error handling"](https://stackoverflow.com/questions/40809504/idiomatic-goroutine-termination-and-error-handling), StackOverflow, 2016
+* ["Return error from the channel"](https://stackoverflow.com/questions/25142016/return-error-from-the-channel), StackOverflow, 2014
+* ["Capture Output and Errors of Goroutine Using Channels"](https://stackoverflow.com/questions/48981528/capture-output-and-errors-of-goroutine-using-channels), StackOverflow, 2018
+
 ## Miscelaneous
-* [Buy Me a Coffe badge](https://gist.github.com/gbraad/216f8162d9b382d14b8a097a37cc2c72#file-readme-md)
+* [Buy Me a Coffee badge](https://gist.github.com/gbraad/216f8162d9b382d14b8a097a37cc2c72#file-readme-md)

pkg/morserino_console/console_display.go → pkg/morserino/channels.go

@@ -1,4 +1,4 @@
-package morserino_console
+package morserino
 
 /*
 Copyright © 2021 Jean-Marc Meessen, ON4KJM <[email protected]>
@@ -22,30 +22,25 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
-import (
-	"fmt"
-	"strings"
-)
+// Structure containing all the channels used by the application
+type MorserinoChannels struct {
+	// Channel for the data flow from serial port to display goroutines
+	MessageBuffer chan string
 
-//FIXME: Add comment
-type ConsoleDisplay struct {
-	currentLine string
-	newLine     string
-}
+	// Channel indicating that all data has been displayed and that the
+	// application can be closed
+	DisplayCompleted chan bool
 
-func (cd *ConsoleDisplay) String() string {
-	//FIXME: add something useful here
-	return ""
-}
+	Done chan bool
 
-func (cd *ConsoleDisplay) Add(buff string) {
-	if strings.Contains(buff, "=") {
-		//FIXME: is the buffer one char long
-		fmt.Println("=")
-	} else {
-		fmt.Printf("%s", buff)
-	}
+	// Channel used to report back errors in goroutines
+	Error chan error
 }
 
-//TODO: add break on column
-//TODO: Add tests
+//Initialize the channels
+func (mc *MorserinoChannels) Init() {
+	mc.MessageBuffer = make(chan string, 10)
+	mc.DisplayCompleted = make(chan bool)
+	mc.Done = make(chan bool)
+	mc.Error = make(chan error, 10)
+}

pkg/morserino_com/list_com.go → pkg/morserino/com_list.go

@@ -1,4 +1,4 @@
-package morserino_com
+package morserino
 
 /*
 Copyright © 2021 Jean-Marc Meessen, ON4KJM <[email protected]>

pkg/morserino_com/list_com_test.go → pkg/morserino/com_list_test.go

@@ -1,4 +1,4 @@
-package morserino_com
+package morserino
 
 /*
 Copyright © 2021 Jean-Marc Meessen, ON4KJM <[email protected]>

pkg/morserino_com/listen_com.go → pkg/morserino/com_listen.go

@@ -1,4 +1,4 @@
-package morserino_com
+package morserino
 
 /*
 Copyright © 2021 Jean-Marc Meessen, ON4KJM <[email protected]>
@@ -25,33 +25,41 @@ THE SOFTWARE.
 import (
 	"fmt"
 	"io"
-	"log"
 	"strings"
 	"testing/iotest"
 
-	"github.com/on4kjm/morserino_display/pkg/morserino_console"
+	// "github.com/rs/zerolog"
 	"go.bug.st/serial"
 )
 
+const exitString string = "\nExiting...\n"
+
 // Main listen function with display to the console
-func ConsoleListen(morserinoPortName string, genericEnumPorts comPortEnumerator) error {
+func OpenAndListen(morserinoPortName string, genericEnumPorts comPortEnumerator, channels *MorserinoChannels) {
 
 	//If requested, use the simulator instead of a real Morserino
 	if strings.HasPrefix("SIMULATOR", strings.ToUpper(morserinoPortName)) {
+		AppLogger.Debug().Msg("Simulator mode listener")
 		TestMessage := "cq cq de on4kjm on4kjm = tks fer call om = ur rst 599 = hw? \n73 de on4kjm = <sk> e e"
-		return Listen(iotest.OneByteReader(strings.NewReader(TestMessage)))
+		err := Listen(iotest.OneByteReader(strings.NewReader(TestMessage)), channels)
+		channels.Error <- err
+		return
 	}
 
 	//If portname "auto" was specified, we scan for the Morserino port
 	if strings.ToUpper(morserinoPortName) == "AUTO" {
+		AppLogger.Debug().Msg("Tying to detect the morsorino port")
 		portName, err := DetectDevice(genericEnumPorts)
+		channels.Error <- err
 		if err != nil {
-			return err
+			channels.MessageBuffer <- exitString
+			channels.Done <- true
+			return
 		}
 		morserinoPortName = portName
 	}
 
-	log.Println("Listening to port \"" + morserinoPortName + "\"")
+	AppLogger.Info().Msg("Listening to port \"" + morserinoPortName + "\"")
 
 	//Port parameters for a Morserino
 	mode := &serial.Mode{
@@ -61,20 +69,25 @@ func ConsoleListen(morserinoPortName string, genericEnumPorts comPortEnumerator)
 		StopBits: serial.OneStopBit,
 	}
 
+	AppLogger.Debug().Msg("Trying to open " + morserinoPortName)
 	p, err := serial.Open(morserinoPortName, mode)
 	if err != nil {
-		return err
+		AppLogger.Error().Err(err).Msg("Error opening port")
+		channels.Error <- err
+		return
 	}
 	defer p.Close()
 
-	return Listen(p)
+	err = Listen(p, channels)
+	channels.Error <- err
+	return
 }
 
 // Main receive loop
-func Listen(port io.Reader) error {
+func Listen(port io.Reader, channels *MorserinoChannels) error {
 
-	//TODO: needs to be moved as a goroutine
-	consoleDisplay := morserino_console.ConsoleDisplay{}
+	// //TODO: needs to be moved as a goroutine
+	// consoleDisplay := morserino_console.ConsoleDisplay{}
 
 	// variables for tracking the exit pattern
 	var (
@@ -88,7 +101,7 @@ func Listen(port io.Reader) error {
 		// Reads up to 100 bytes
 		n, err := port.Read(buff)
 		if err != nil {
-			log.Fatal(err)
+			AppLogger.Error().Err(err).Msg("Error reading on port")
 		}
 
 		// Check whether the "end of transmission" was sent
@@ -110,23 +123,40 @@ func Listen(port io.Reader) error {
 		}
 
 		if n == 0 {
-			fmt.Println("\nEOF")
+			AppLogger.Debug().Msg("EOF detectd")
+			AppLogger.Trace().Msg("Sending EOF to the console displayer")
+			channels.MessageBuffer <- "\nEOF"
+			//sending the exit marker to the diplay goroutine
+			AppLogger.Trace().Msg("Sending exit marker to the console displayer")
+			channels.MessageBuffer <- exitString
+			//waiting for it to complete (blocking read)
+			AppLogger.Debug().Msg("Waiting for the signal that the display processing was completed")
+			<-channels.DisplayCompleted
+			AppLogger.Debug().Msg("Display processing completed (received signal)")
 			break
 		}
 
-		// TODO: move this out and use a channel for that
-		consoleDisplay.Add(string(buff[:n]))
+		channels.MessageBuffer <- string(buff[:n])
 
 		if closeRequested {
-			consoleDisplay.Add("\nExiting...\n")
+			//sending the exit marker to the diplay goroutine
+			AppLogger.Trace().Msg("Sending exit marker to the console displayer as we received the exit sequence")
+			channels.MessageBuffer <- exitString
+			//waiting for it to complete (blocking read)
+			AppLogger.Debug().Msg("Waiting for the signal that the display processing was completed")
+			<-channels.DisplayCompleted
+			AppLogger.Debug().Msg("Display processing completed (received signal)")
 			break
 		}
 	}
+	AppLogger.Debug().Msg("Sending signal that all processing is done")
+	channels.Done <- true
 
+	AppLogger.Debug().Msg("Exiting Listen")
 	return nil
 }
 
-// Tries to auto detect the Morserino port
+// Tries to auto detect the Morserino port based on the USB Vendor and Device ID
 func DetectDevice(genericEnumPorts comPortEnumerator) (string, error) {
 	theComPortList, err := Get_com_list(genericEnumPorts)
 	if err != nil {