Refactor package errors + packages names :

- Refactor ErrorType, list errors managment, codeError
- Add interface Error with error interface implement
- Add type CodeError assign typiclly to const that represent code of error
- Add func to registry func to retrieve message from an uint16 codeError (typicaly a switch of each codeError const)
- Add default errorCode with default errorMessage if no one code or message is found
- Add modeError to manage how to manage compatibility between Error interface and error interface
- Add Error interface that allow parent link (parent as error or Error interface), code and trace management
- Add trace finder to allow find func/file/line caller when Error is call
- Add http 2 transport in httpcli
- Add http 2 transport in httpserver
- Add function to get client http with timeout management in httpcli
- Add function to get Error if occurs of http client in httpcli
- Add test for smtp package
- Chg return error by returning Error in all packages
- Chg package njs-archive by archive
- Chg package njs-certif by certificates
- Chg package njs-console by console
- Chg package njs-crypt by crypt
- Chg package njs-errors by errors
- Chg package njs-httpcli by httpcli
- Chg package njs-httpserver by httpserver
- Chg package njs-ioutils by ioutils
- Chg package njs-ldap by ldap
- Chg package njs-logger by logger
- Chg package njs-password by password
- Chg package njs-progress by progress
- Chg package njs-router by router
- Chg package njs-semaphore by semaphore
- Chg package njs-smtp by smtp
- Chg package njs-static by static
- Chg package njs-status by status
- Chg package njs-version by version
- Fix dependancies gopkg by github/go-ldap for go module compatibility
- Fix gin Abort call by gin Abort with Error in static package
- Fix issue #18 in status package : replace partner by component
- Fix go vet error
- Del deprecated function
- Del useless function & files
- Bump dependancies
- Apply CHG in README.md
This commit is contained in:
Nicolas JUHEL
2020-07-14 11:00:57 +02:00
parent 9570840431
commit ca39d7ad26
103 changed files with 2647 additions and 885 deletions

0
console/README.md Normal file
View File

128
console/color.go Normal file
View File

@@ -0,0 +1,128 @@
/*
* MIT License
*
* Copyright (c) 2019 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package console
import (
"bufio"
"fmt"
"github.com/fatih/color"
. "github.com/nabbar/golib/errors"
)
type colorType uint8
var (
colorList map[colorType]*color.Color
)
const (
ColorPrint colorType = iota
ColorPrompt
)
func init() {
colorList = map[colorType]*color.Color{
ColorPrint: nil,
ColorPrompt: nil,
}
}
func GetColorType(colId uint8) colorType {
return colorType(colId)
}
func SetColor(col colorType, value ...int) {
var cols = make([]color.Attribute, 0)
for _, v := range value {
cols = append(cols, color.Attribute(v))
}
colorList[col] = color.New(cols...)
}
func (c colorType) SetColor(col *color.Color) {
colorList[c] = col
}
func (c colorType) Println(text string) {
if colorList[c] != nil {
_, _ = colorList[c].Println(text) // #nosec
} else {
println(text)
}
}
func (c colorType) Print(text string) {
if colorList[c] != nil {
_, _ = colorList[c].Print(text) // #nosec
} else {
print(text)
}
}
func (c colorType) BuffPrintf(buff *bufio.ReadWriter, format string, args ...interface{}) (n int, err Error) {
if colorList[c] != nil && buff != nil {
i, e := colorList[c].Fprintf(buff, format, args...) // #nosec
if e != nil {
return i, COLOR_IO_FRINTF.ErrorParent(e)
}
return i, nil
} else if buff != nil {
i, e := buff.Write([]byte(fmt.Sprintf(format, args...)))
if e != nil {
return i, COLOR_BUFF_WRITE.ErrorParent(e)
}
return i, nil
} else {
return 0, COLOR_BUFF_UNDEFINED.Error(nil)
}
}
func (c colorType) Sprintf(format string, args ...interface{}) string {
if colorList[c] != nil {
return colorList[c].Sprintf(format, args...) // #nosec
} else {
return fmt.Sprintf(format, args...)
}
}
func (c colorType) Printf(format string, args ...interface{}) {
c.Print(fmt.Sprintf(format, args...))
}
func (c colorType) PrintfLn(format string, args ...interface{}) {
c.Println(fmt.Sprintf(format, args...))
}

55
console/error.go Normal file
View File

@@ -0,0 +1,55 @@
/*
* MIT License
*
* Copyright (c) 2020 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package console
import errors "github.com/nabbar/golib/errors"
const (
EMPTY_PARAMS errors.CodeError = iota + errors.MIN_PKG_Console
COLOR_IO_FRINTF
COLOR_BUFF_WRITE
COLOR_BUFF_UNDEFINED
)
func init() {
errors.RegisterFctMessage(getMessage)
}
func getMessage(code errors.CodeError) (message string) {
switch code {
case EMPTY_PARAMS:
return "given parameters is empty"
case COLOR_IO_FRINTF:
return "cannot write on IO"
case COLOR_BUFF_WRITE:
return "cannot write on buffer"
case COLOR_BUFF_UNDEFINED:
return "buffer is not defined"
}
return ""
}

50
console/padding.go Normal file
View File

@@ -0,0 +1,50 @@
/*
* MIT License
*
* Copyright (c) 2019 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package console
import (
"strings"
"unicode/utf8"
)
func padTimes(str string, n int) (out string) {
for i := 0; i < n; i++ {
out += str
}
return
}
func PadLeft(str string, len int, pad string) string {
return padTimes(pad, len-utf8.RuneCountInString(str)) + str
}
func PadRight(str string, len int, pad string) string {
return str + padTimes(pad, len-utf8.RuneCountInString(str))
}
func PrintTab(tablLevel int, format string, args ...interface{}) {
ColorPrint.Printf(strings.Repeat(" ", tablLevel)+format, args...)
}

104
console/prompt.go Normal file
View File

@@ -0,0 +1,104 @@
/*
* MIT License
*
* Copyright (c) 2019 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package console
import (
"bufio"
"fmt"
"net/url"
"os"
"strconv"
"golang.org/x/crypto/ssh/terminal"
)
func printPrompt(text string) {
if text != "" {
ColorPrompt.Printf("%s: ", text)
}
}
func PromptString(text string) (string, error) {
var (
scn *bufio.Scanner = bufio.NewScanner(os.Stdin)
res string
err error
)
printPrompt(text)
for scn.Scan() {
res = scn.Text()
err = scn.Err()
break
}
return res, err
}
func PromptInt(text string) (int64, error) {
if str, err := PromptString(text); err != nil {
return 0, err
} else {
return strconv.ParseInt(str, 10, 64)
}
}
func PromptUrl(text string) (*url.URL, error) {
if str, err := PromptString(text); err != nil {
return nil, err
} else {
return url.Parse(str)
}
}
func PromptBool(text string) (bool, error) {
if str, err := PromptString(text); err != nil {
return false, err
} else {
return strconv.ParseBool(str)
}
}
func PromptPassword(text string) (string, error) {
var (
res string
err error
)
printPrompt(text)
res, err = getTerminal().ReadPassword("")
fmt.Printf("\n")
return res, err
}
func getTerminal() *terminal.Terminal {
r := bufio.NewReader(os.Stdin)
w := bufio.NewWriter(os.Stdout)
b := bufio.NewReadWriter(r, w)
return terminal.NewTerminal(b, "")
}