Merge pull request #195 from mtuska/xmlHeader

Add Option to Exclude XML Header for NETCONF Messages

.github/workflows/commit.yaml

@@ -38,7 +38,7 @@ jobs:
       - name: lint
         uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.60
+          version: v1.61
           args: --timeout 5m
 
       - name: install gotestsum

.golangci.yaml

@@ -123,4 +123,4 @@ output:
   uniq-by-line: false
 
 service:
-  golangci-lint-version: 1.60.x
+  golangci-lint-version: 1.61.x

driver/netconf/capabilities.go

@@ -118,7 +118,7 @@ func (d *Driver) processServerCapabilities() error {
 			string(sessionIDMatch[1]), err)
 	}
 
-	d.sessionID = uint64(i)
+	d.sessionID = uint64(i) //nolint:gosec
 
 	return nil
 }

driver/netconf/driver.go

@@ -188,6 +188,7 @@ type Driver struct {
 	SelectedVersion  string
 
 	ForceSelfClosingTags bool
+	ExcludeHeader        bool
 
 	serverCapabilities []string
 	sessionID          uint64

driver/netconf/message.go

@@ -18,15 +18,21 @@ type serializedInput struct {
 	framedXML []byte
 }
 
-func (m *message) serialize(v string, forceSelfClosingTags bool) (*serializedInput, error) {
+func (m *message) serialize(
+	v string,
+	forceSelfClosingTags,
+	excludeHeader bool,
+) (*serializedInput, error) {
 	serialized := &serializedInput{}
 
 	msg, err := xml.Marshal(m)
 	if err != nil {
 		return nil, err
 	}
 
-	msg = append([]byte(xmlHeader), msg...)
+	if !excludeHeader {
+		msg = append([]byte(xmlHeader), msg...)
+	}
 
 	if forceSelfClosingTags {
 		msg = ForceSelfClosingTags(msg)

driver/netconf/rpc.go

@@ -35,7 +35,7 @@ func (d *Driver) sendRPC(
 		d.Logger.Debug("ForceSelfClosingTags is true, enforcing...")
 	}
 
-	serialized, err := m.serialize(d.SelectedVersion, d.ForceSelfClosingTags)
+	serialized, err := m.serialize(d.SelectedVersion, d.ForceSelfClosingTags, d.ExcludeHeader)
 	if err != nil {
 		return nil, err
 	}

driver/options/netconf.go

@@ -45,3 +45,19 @@ func WithNetconfForceSelfClosingTags() util.Option {
 		return nil
 	}
 }
+
+// WithNetconfExcludeHeader excludes the XML header from the NETCONF message.
+// This is useful for devices that do not support the XML header.
+func WithNetconfExcludeHeader() util.Option {
+	return func(o interface{}) error {
+		d, ok := o.(*netconf.Driver)
+
+		if !ok {
+			return util.ErrIgnoredOption
+		}
+
+		d.ExcludeHeader = true
+
+		return nil
+	}
+}