Merge pull request #435 from essentialkaos/develop

Version 12.102.0

CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Changelog
 
+### 12.102.0
+
+* `[knf/validators/network]` Added `Mail` validator
+* `[log]` Added `Divider` method
+* `[knf/validators/fs]` Code refactoring
+* `[knf/validators/network]` Code refactoring
+* `[knf/validators/regexp]` Code refactoring
+* `[knf/validators/system]` Code refactoring
+
 ### 12.101.0
 
 * `[req]` Added Bearer Token property to `Request` struct

ek.go

@@ -20,7 +20,7 @@ import (
 // ////////////////////////////////////////////////////////////////////////////////// //
 
 // VERSION is current ek package version
-const VERSION = "12.101.0"
+const VERSION = "12.102.0"
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 

knf/validators/fs/validators.go

@@ -91,13 +91,13 @@ func validateOwner(config *knf.Config, prop string, value any) error {
 	user, err := system.LookupUser(owner)
 
 	if err != nil {
-		return fmt.Errorf("Can't find user %s on system", owner)
+		return fmt.Errorf("Can't find user %q on system", owner)
 	}
 
 	uid, _, err := fsutil.GetOwner(target)
 
 	if err != nil {
-		return fmt.Errorf("Can't get owner for %s", target)
+		return fmt.Errorf("Can't get owner for %q", target)
 	}
 
 	if user.UID != uid {
@@ -118,13 +118,13 @@ func validateOwnerGroup(config *knf.Config, prop string, value any) error {
 	group, err := system.LookupGroup(ownerGroup)
 
 	if err != nil {
-		return fmt.Errorf("Can't find group %s on system", ownerGroup)
+		return fmt.Errorf("Can't find group %q on system", ownerGroup)
 	}
 
 	_, gid, err := fsutil.GetOwner(target)
 
 	if err != nil {
-		return fmt.Errorf("Can't get owner group for %s", target)
+		return fmt.Errorf("Can't get owner group for %q", target)
 	}
 
 	if group.GID != gid {
@@ -145,7 +145,7 @@ func validateFileMode(config *knf.Config, prop string, value any) error {
 	targetPerms := fsutil.GetMode(target)
 
 	if targetPerms == 0 {
-		return fmt.Errorf("Can't get mode for %s", target)
+		return fmt.Errorf("Can't get mode for %q", target)
 	}
 
 	if perms != targetPerms {
@@ -171,7 +171,7 @@ func validateMatchPattern(config *knf.Config, prop string, value any) error {
 	}
 
 	if !isMatch {
-		return fmt.Errorf("Property %s must match shell pattern %s", prop, pattern)
+		return fmt.Errorf("Property %s must match shell pattern %q", prop, pattern)
 	}
 
 	return nil

knf/validators/fs/validators_test.go

@@ -108,7 +108,7 @@ func (s *ValidatorSuite) TestOwnerValidator(c *C) {
 
 	c.Assert(errs, HasLen, 2)
 	c.Assert(errs[0].Error(), Equals, "User nobody must be owner of /etc/passwd")
-	c.Assert(errs[1].Error(), Equals, "Can't find user somerandomuser on system")
+	c.Assert(errs[1].Error(), Equals, `Can't find user "somerandomuser" on system`)
 
 	configFile = createConfig(c, "/etc/__unknown__")
 
@@ -120,7 +120,7 @@ func (s *ValidatorSuite) TestOwnerValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "Can't get owner for /etc/__unknown__")
+	c.Assert(errs[0].Error(), Equals, `Can't get owner for "/etc/__unknown__"`)
 }
 
 func (s *ValidatorSuite) TestOwnerGroupValidator(c *C) {
@@ -152,7 +152,7 @@ func (s *ValidatorSuite) TestOwnerGroupValidator(c *C) {
 
 	c.Assert(errs, HasLen, 2)
 	c.Assert(errs[0].Error(), Equals, "Group daemon must be owner of /etc/passwd")
-	c.Assert(errs[1].Error(), Equals, "Can't find group somerandomgroup on system")
+	c.Assert(errs[1].Error(), Equals, `Can't find group "somerandomgroup" on system`)
 
 	configFile = createConfig(c, "/etc/__unknown__")
 
@@ -164,7 +164,7 @@ func (s *ValidatorSuite) TestOwnerGroupValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "Can't get owner group for /etc/__unknown__")
+	c.Assert(errs[0].Error(), Equals, `Can't get owner group for "/etc/__unknown__"`)
 }
 
 func (s *ValidatorSuite) TestFileModeValidator(c *C) {
@@ -197,7 +197,7 @@ func (s *ValidatorSuite) TestFileModeValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "Can't get mode for /etc/__unknown__")
+	c.Assert(errs[0].Error(), Equals, `Can't get mode for "/etc/__unknown__"`)
 }
 
 func (s *ValidatorSuite) TestMatchPattern(c *C) {
@@ -219,7 +219,7 @@ func (s *ValidatorSuite) TestMatchPattern(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 2)
-	c.Assert(errs[0].Error(), Equals, "Property test:test1 must match shell pattern /var/*")
+	c.Assert(errs[0].Error(), Equals, `Property test:test1 must match shell pattern "/var/*"`)
 	c.Assert(errs[1].Error(), Equals, "Can't parse shell pattern: syntax error in pattern")
 }
 

knf/validators/network/validators.go

@@ -12,6 +12,7 @@ import (
 	"fmt"
 	"net"
 	"net/url"
+	"strings"
 
 	"github.com/essentialkaos/ek/v12/knf"
 )
@@ -34,6 +35,9 @@ var (
 	// URL returns error if config property isn't a valid URL
 	URL = validateURL
 
+	// Mail returns error if config property isn't a valid email address
+	Mail = validateMail
+
 	// HasIP returns error if system doesn't have interface with IP from config property
 	HasIP = validateHasIP
 )
@@ -50,7 +54,7 @@ func validateIP(config *knf.Config, prop string, value any) error {
 	ip := net.ParseIP(ipStr)
 
 	if ip == nil {
-		return fmt.Errorf("%s is not a valid IP address", ipStr)
+		return fmt.Errorf("%q is not a valid IP address", ipStr)
 	}
 
 	return nil
@@ -66,7 +70,7 @@ func validatePort(config *knf.Config, prop string, value any) error {
 	portInt := config.GetI(prop)
 
 	if portInt == 0 || portInt > 65535 {
-		return fmt.Errorf("%s is not a valid port number", portStr)
+		return fmt.Errorf("%q is not a valid port number", portStr)
 	}
 
 	return nil
@@ -82,7 +86,7 @@ func validateMAC(config *knf.Config, prop string, value any) error {
 	_, err := net.ParseMAC(macStr)
 
 	if err != nil {
-		return fmt.Errorf("%s is not a valid MAC address: %v", macStr, err)
+		return fmt.Errorf("%q is not a valid MAC address: %v", macStr, err)
 	}
 
 	return nil
@@ -98,7 +102,7 @@ func validateCIDR(config *knf.Config, prop string, value any) error {
 	_, _, err := net.ParseCIDR(cidrStr)
 
 	if err != nil {
-		return fmt.Errorf("%s is not a valid CIDR address: %v", cidrStr, err)
+		return fmt.Errorf("%q is not a valid CIDR address: %v", cidrStr, err)
 	}
 
 	return nil
@@ -114,7 +118,21 @@ func validateURL(config *knf.Config, prop string, value any) error {
 	_, err := url.ParseRequestURI(urlStr)
 
 	if err != nil {
-		return fmt.Errorf("%s is not a valid URL address: %v", urlStr, err)
+		return fmt.Errorf("%q is not a valid URL address: %v", urlStr, err)
+	}
+
+	return nil
+}
+
+func validateMail(config *knf.Config, prop string, value any) error {
+	mailStr := config.GetS(prop)
+
+	if mailStr == "" {
+		return nil
+	}
+
+	if !strings.ContainsRune(mailStr, '@') || !strings.ContainsRune(mailStr, '.') {
+		return fmt.Errorf("%q is not a valid email address", mailStr)
 	}
 
 	return nil
@@ -147,5 +165,5 @@ func validateHasIP(config *knf.Config, prop string, value any) error {
 		}
 	}
 
-	return fmt.Errorf("The system does not have an interface with the address %s", ipStr)
+	return fmt.Errorf("The system does not have an interface with the address %q", ipStr)
 }

knf/validators/network/validators_test.go

@@ -45,6 +45,12 @@ const _CONFIG_DATA = `
 	test0:
 	test1: https://google.com
 	test2: google.com/abcd.php
+
+[mail]
+	test0:
+	test1: unknown
+	test2: unknown@domain
+	test3: unknown@domain.com
 `
 
 // ////////////////////////////////////////////////////////////////////////////////// //
@@ -81,7 +87,7 @@ func (s *ValidatorSuite) TestIPValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "300.0.400.5 is not a valid IP address")
+	c.Assert(errs[0].Error(), Equals, `"300.0.400.5" is not a valid IP address`)
 }
 
 func (s *ValidatorSuite) TestHasIPValidator(c *C) {
@@ -102,7 +108,7 @@ func (s *ValidatorSuite) TestHasIPValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "The system does not have an interface with the address 192.168.1.254")
+	c.Assert(errs[0].Error(), Equals, `The system does not have an interface with the address "192.168.1.254"`)
 }
 
 func (s *ValidatorSuite) TestPortValidator(c *C) {
@@ -124,8 +130,8 @@ func (s *ValidatorSuite) TestPortValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 2)
-	c.Assert(errs[0].Error(), Equals, "ABCD is not a valid port number")
-	c.Assert(errs[1].Error(), Equals, "78361 is not a valid port number")
+	c.Assert(errs[0].Error(), Equals, `"ABCD" is not a valid port number`)
+	c.Assert(errs[1].Error(), Equals, `"78361" is not a valid port number`)
 }
 
 func (s *ValidatorSuite) TestMACValidator(c *C) {
@@ -146,7 +152,7 @@ func (s *ValidatorSuite) TestMACValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "ABCD is not a valid MAC address: address ABCD: invalid MAC address")
+	c.Assert(errs[0].Error(), Equals, `"ABCD" is not a valid MAC address: address ABCD: invalid MAC address`)
 }
 
 func (s *ValidatorSuite) TestCIDRValidator(c *C) {
@@ -167,7 +173,7 @@ func (s *ValidatorSuite) TestCIDRValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "127.0.0.1/200 is not a valid CIDR address: invalid CIDR address: 127.0.0.1/200")
+	c.Assert(errs[0].Error(), Equals, `"127.0.0.1/200" is not a valid CIDR address: invalid CIDR address: 127.0.0.1/200`)
 }
 
 func (s *ValidatorSuite) TestURLValidator(c *C) {
@@ -188,7 +194,25 @@ func (s *ValidatorSuite) TestURLValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "google.com/abcd.php is not a valid URL address: parse \"google.com/abcd.php\": invalid URI for request")
+	c.Assert(errs[0].Error(), Equals, `"google.com/abcd.php" is not a valid URL address: parse "google.com/abcd.php": invalid URI for request`)
+}
+
+func (s *ValidatorSuite) TestMailValidator(c *C) {
+	configFile := createConfig(c, _CONFIG_DATA)
+
+	err := knf.Global(configFile)
+	c.Assert(err, IsNil)
+
+	errs := knf.Validate([]*knf.Validator{
+		{"mail:test0", Mail, nil},
+		{"mail:test1", Mail, nil},
+		{"mail:test2", Mail, nil},
+		{"mail:test3", Mail, nil},
+	})
+
+	c.Assert(errs, HasLen, 2)
+	c.Assert(errs[0].Error(), Equals, `"unknown" is not a valid email address`)
+	c.Assert(errs[1].Error(), Equals, `"unknown@domain" is not a valid email address`)
 }
 
 // ////////////////////////////////////////////////////////////////////////////////// //

knf/validators/regexp/validators.go

@@ -39,7 +39,7 @@ func validateRegexp(config *knf.Config, prop string, value any) error {
 	}
 
 	if !isMatch {
-		return fmt.Errorf("Property %s must match regexp pattern %s", prop, pattern)
+		return fmt.Errorf("Property %s must match regexp pattern %q", prop, pattern)
 	}
 
 	return nil

knf/validators/regexp/validators_test.go

@@ -63,7 +63,7 @@ func (s *ValidatorSuite) TestRegexpValidator(c *check.C) {
 	})
 
 	c.Assert(errs, check.HasLen, 2)
-	c.Assert(errs[0].Error(), check.Equals, "Property regexp:test2 must match regexp pattern ^[A-Z0-9]{4}$")
+	c.Assert(errs[0].Error(), check.Equals, `Property regexp:test2 must match regexp pattern "^[A-Z0-9]{4}$"`)
 	c.Assert(errs[1].Error(), check.Equals, "Can't use given regexp pattern: error parsing regexp: trailing backslash at end of expression: ``")
 }
 

knf/validators/system/validators.go

@@ -38,7 +38,7 @@ func validateUser(config *knf.Config, prop string, value any) error {
 	}
 
 	if !system.IsUserExist(userNameOrID) {
-		return fmt.Errorf("User %s is not present on the system", userNameOrID)
+		return fmt.Errorf("User %q is not present on the system", userNameOrID)
 	}
 
 	return nil
@@ -52,7 +52,7 @@ func validateGroup(config *knf.Config, prop string, value any) error {
 	}
 
 	if !system.IsGroupExist(groupNameOrID) {
-		return fmt.Errorf("Group %s is not present on the system", groupNameOrID)
+		return fmt.Errorf("Group %q is not present on the system", groupNameOrID)
 	}
 
 	return nil

knf/validators/system/validators_linux.go

@@ -42,7 +42,7 @@ func validateInterface(config *knf.Config, prop string, value any) error {
 	_, isPresent := stats[interfaceName]
 
 	if !isPresent {
-		return fmt.Errorf("Interface %s is not present on the system", interfaceName)
+		return fmt.Errorf("Interface %q is not present on the system", interfaceName)
 	}
 
 	return nil

knf/validators/system/validators_linux_test.go

@@ -33,5 +33,5 @@ func (s *ValidatorSuite) TestInterfaceValidator(c *C) {
 	})
 
 	c.Assert(errs, HasLen, 1)
-	c.Assert(errs[0].Error(), Equals, "Interface abc is not present on the system")
+	c.Assert(errs[0].Error(), Equals, `Interface "abc" is not present on the system`)
 }

log/example_test.go

@@ -42,6 +42,9 @@ func Example() {
 	// any minimum level
 	logger.Aux("This is aux message")
 
+	// Print simple divider
+	logger.Divider()
+
 	// For log rotation we provide method Reopen
 	logger.Reopen()
 
@@ -223,6 +226,17 @@ func ExampleAux() {
 	Aux("Auxiliary message")
 }
 
+func ExampleDivider() {
+	err := Set("/path/to/file.log", 0644)
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	Divider()
+}
+
 func ExampleIs() {
 	err := Set("/path/to/file.log", 0644)
 
@@ -391,6 +405,17 @@ func ExampleLogger_Aux() {
 	logger.Aux("Auxiliary message")
 }
 
+func ExampleLogger_Divider() {
+	logger, err := New("/path/to/file.log", 0644)
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	logger.Divider()
+}
+
 func ExampleLogger_Is() {
 	logger, err := New("/path/to/file.log", 0644)