MAJOR: acl: use same type in config parser as in rest of the module

Author: oktalz

.aspell.yml

@@ -2,6 +2,7 @@
 mode: commit
 min_length: 3
 allowed:
+  - acl
   - acls
   - adfs
   - addons

config-parser/common/metadata.go

@@ -0,0 +1,46 @@
+/*
+Copyright 2019 HAProxy Technologies
+
+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 "github.com/haproxytech/client-native/v6/config-parser/errors"
+
+// ExtractComment extracts the comment from the metadata map.
+func ExtractComment(metadata map[string]interface{}) string {
+	var comment string
+	if metadata == nil {
+		return comment
+	}
+	if cmt, ok := metadata["comment"]; ok && cmt != "" {
+		comment, _ = cmt.(string)
+	}
+	return comment
+}
+
+// ExtractCommentWithErr extracts the comment from the metadata map and returns an error if the comment is not a string.
+func ExtractCommentWithErr(metadata map[string]interface{}) (string, error) {
+	var comment string
+	if metadata == nil {
+		return comment, nil
+	}
+	if cmt, ok := metadata["comment"]; ok && cmt != "" {
+		comment, ok = cmt.(string)
+		if !ok {
+			return "", errors.ErrInvalidData
+		}
+	}
+	return comment, nil
+}

config-parser/parsers/acl.go

@@ -21,21 +21,25 @@ import (
 
 	"github.com/haproxytech/client-native/v6/config-parser/common"
 	"github.com/haproxytech/client-native/v6/config-parser/errors"
-	"github.com/haproxytech/client-native/v6/config-parser/types"
+	"github.com/haproxytech/client-native/v6/models"
 )
 
 type ACL struct {
-	data        []types.ACL
+	data        []models.ACL
 	preComments []string // comments that appear before the actual line
 }
 
-func (h *ACL) parse(line string, parts []string, comment string) (*types.ACL, error) {
+func (h *ACL) parse(line string, parts []string, comment string) (*models.ACL, error) {
 	if len(parts) >= 3 {
-		data := &types.ACL{
-			Name:      parts[1],
+		data := &models.ACL{
+			ACLName:   parts[1],
 			Criterion: parts[2],
 			Value:     strings.Join(parts[3:], " "),
-			Comment:   comment,
+			Metadata:  map[string]interface{}{},
+		}
+		if comment != "" {
+			data.Metadata = map[string]interface{}{}
+			data.Metadata["comment"] = comment
 		}
 		return data, nil
 	}
@@ -50,14 +54,14 @@ func (h *ACL) Result() ([]common.ReturnResultLine, error) {
 	for index, req := range h.data {
 		var sb strings.Builder
 		sb.WriteString("acl ")
-		sb.WriteString(req.Name)
+		sb.WriteString(req.ACLName)
 		sb.WriteString(" ")
 		sb.WriteString(req.Criterion)
 		sb.WriteString(" ")
 		sb.WriteString(req.Value)
 		result[index] = common.ReturnResultLine{
 			Data:    sb.String(),
-			Comment: req.Comment,
+			Comment: common.ExtractComment(req.Metadata),
 		}
 	}
 	return result, nil

config-parser/parsers/acl_generated.go

@@ -102,8 +102,12 @@ type LogStdErr struct {
 	Comment     string
 }
 
-//sections:frontend,backend,defaults
+// ACL
+// model:ACL
+//
 //name:acl
+//doc:https://docs.haproxy.org/dev/configuration.html#acl%20(Alphabetically%20sorted%20keywords%20reference)
+//sections:frontend,backend,defaults
 //is:multiple
 //test:ok:acl url_stats path_beg /stats
 //test:ok:acl url_static path_beg -i /static /images /javascript /stylesheets
@@ -122,12 +126,7 @@ type LogStdErr struct {
 //test:ok:acl cookie_set hdr_sub(cookie) SEEN=1
 //test:fail:acl cookie
 //test:fail:acl
-type ACL struct {
-	Name      string
-	Criterion string
-	Value     string
-	Comment   string
-}
+type ACL struct{}
 
 //sections:frontend
 //name:bind

config-parser/types/types.go

@@ -22,7 +22,6 @@ import (
 	"github.com/go-openapi/strfmt"
 	parser "github.com/haproxytech/client-native/v6/config-parser"
 	parser_errors "github.com/haproxytech/client-native/v6/config-parser/errors"
-	"github.com/haproxytech/client-native/v6/config-parser/types"
 
 	"github.com/haproxytech/client-native/v6/models"
 )
@@ -85,9 +84,9 @@ func (c *client) GetACL(id int64, parentType, parentName string, transactionID s
 		return v, nil, c.HandleError(strconv.FormatInt(id, 10), parentType, parentName, "", false, err)
 	}
 
-	acl := ParseACL(data.(types.ACL))
+	acl := data.(models.ACL)
 
-	return v, acl, nil
+	return v, &acl, nil
 }
 
 // DeleteACL deletes a ACL line in configuration. One of version or transactionID is
@@ -130,7 +129,7 @@ func (c *client) CreateACL(id int64, parentType string, parentName string, data
 		return err
 	}
 
-	if err := p.Insert(section, parentName, "acl", SerializeACL(*data), int(id)); err != nil {
+	if err := p.Insert(section, parentName, "acl", *data, int(id)); err != nil {
 		return c.HandleError(strconv.FormatInt(id, 10), parentType, parentName, t, transactionID == "", err)
 	}
 
@@ -160,7 +159,7 @@ func (c *client) EditACL(id int64, parentType string, parentName string, data *m
 		return c.HandleError(strconv.FormatInt(id, 10), parentType, parentName, t, transactionID == "", err)
 	}
 
-	if err := p.Set(section, parentName, "acl", SerializeACL(*data), int(id)); err != nil {
+	if err := p.Set(section, parentName, "acl", *data, int(id)); err != nil {
 		return c.HandleError(strconv.FormatInt(id, 10), parentType, parentName, t, transactionID == "", err)
 	}
 
@@ -200,7 +199,7 @@ func (c *client) ReplaceAcls(parentType string, parentName string, data models.A
 	}
 
 	for i, newACL := range data {
-		if err := p.Insert(section, parentName, "acl", SerializeACL(*newACL), i); err != nil {
+		if err := p.Insert(section, parentName, "acl", *newACL, i); err != nil {
 			return c.HandleError(strconv.FormatInt(int64(i), 10), parentType, parentName, t, transactionID == "", err)
 		}
 	}
@@ -218,42 +217,17 @@ func ParseACLs(section parser.Section, name string, p parser.Parser, aclName ...
 		return nil, err
 	}
 
-	aclLines, ok := data.([]types.ACL)
+	aclLines, ok := data.([]models.ACL)
 	if !ok {
 		return nil, errors.New("type assert error []types.ACL")
 	}
 	lACL := len(aclName)
-	for _, r := range aclLines {
-		acl := ParseACL(r)
-		if acl != nil {
-			if lACL > 0 && aclName[0] == acl.ACLName {
-				acls = append(acls, acl)
-			} else if lACL == 0 {
-				acls = append(acls, acl)
-			}
+	for _, acl := range aclLines {
+		if lACL > 0 && aclName[0] == acl.ACLName {
+			acls = append(acls, &acl)
+		} else if lACL == 0 {
+			acls = append(acls, &acl)
 		}
 	}
 	return acls, nil
 }
-
-func ParseACL(f types.ACL) *models.ACL {
-	return &models.ACL{
-		ACLName:   f.Name,
-		Criterion: f.Criterion,
-		Value:     f.Value,
-		Metadata:  parseMetadata(f.Comment),
-	}
-}
-
-func SerializeACL(f models.ACL) types.ACL {
-	comment, err := serializeMetadata(f.Metadata)
-	if err != nil {
-		comment = ""
-	}
-	return types.ACL{
-		Name:      f.ACLName,
-		Criterion: f.Criterion,
-		Value:     f.Value,
-		Comment:   comment,
-	}
-}

configuration/acl.go

@@ -300,7 +300,7 @@ func serializeBackendSection(a StructuredToParserArgs, b *models.Backend) error
 		}
 	}
 	for i, acl := range b.ACLList {
-		if err = p.Insert(parser.Backends, b.Name, "acl", SerializeACL(*acl), i); err != nil {
+		if err = p.Insert(parser.Backends, b.Name, "acl", *acl, i); err != nil {
 			return a.HandleError(strconv.FormatInt(int64(i), 10), BackendParentName, b.Name, a.TID, a.TID == "", err)
 		}
 	}

configuration/structured_backends.go

@@ -380,11 +380,10 @@ func serializeDefaultsSection(a StructuredToParserArgs, d *models.Defaults) erro
 		}
 	}
 	for i, acl := range d.ACLList {
-		s := SerializeACL(*acl)
 		if err != nil {
 			return err
 		}
-		if err = p.Insert(parser.Defaults, d.Name, "acl", s, i); err != nil {
+		if err = p.Insert(parser.Defaults, d.Name, "acl", *acl, i); err != nil {
 			return a.HandleError(strconv.FormatInt(int64(i), 10), DefaultsParentName, d.Name, a.TID, a.TID == "", err)
 		}
 	}

configuration/structured_defaults.go

@@ -180,7 +180,7 @@ func serializeFCGIAppSection(a StructuredToParserArgs, f *models.FCGIApp) error
 		return err
 	}
 	for i, acl := range f.ACLList {
-		if err = p.Insert(parser.FCGIApp, f.Name, "acl", SerializeACL(*acl), i); err != nil {
+		if err = p.Insert(parser.FCGIApp, f.Name, "acl", *acl, i); err != nil {
 			return a.HandleError(strconv.FormatInt(int64(i), 10), "fcgi", f.Name, a.TID, a.TID == "", err)
 		}
 	}

configuration/structured_fcgiapps.go

@@ -282,7 +282,7 @@ func serializeFrontendSection(a StructuredToParserArgs, f *models.Frontend, opt
 		}
 	}
 	for i, acl := range f.ACLList {
-		if err = p.Insert(parser.Frontends, f.Name, "acl", SerializeACL(*acl), i); err != nil {
+		if err = p.Insert(parser.Frontends, f.Name, "acl", *acl, i); err != nil {
 			return a.HandleError(strconv.FormatInt(int64(i), 10), FrontendParentName, f.Name, a.TID, a.TID == "", err)
 		}
 	}