v2/soap/envelope - tidy and improve tests.

v2/soap/envelope/envelope.go

@@ -7,14 +7,17 @@ import (
 	"io"
 )
 
+// FaultDetail carries XML-encoded application-specific Fault details.
+type FaultDetail struct {
+	Raw []byte `xml:",innerxml"`
+}
+
 // Fault implements error, and contains SOAP fault information.
 type Fault struct {
-	Code   string `xml:"faultcode"`
-	String string `xml:"faultstring"`
-	Actor  string `xml:"faultactor"`
-	Detail struct {
-		Raw []byte `xml:",innerxml"`
-	} `xml:"detail"`
+	Code   string      `xml:"faultcode"`
+	String string      `xml:"faultstring"`
+	Actor  string      `xml:"faultactor"`
+	Detail FaultDetail `xml:"detail"`
 }
 
 func (fe *Fault) Error() string {
@@ -32,14 +35,28 @@ var (
 	envClose = []byte(`</s:Body></s:Envelope>`)
 )
 
+// Action wraps a SOAP action to be read or written as part of a SOAP envelope.
+type Action struct {
+	// XMLName specifies the XML element namespace (URI) and name. Together
+	// these identify the SOAP action.
+	XMLName xml.Name
+	// Args is an arbitrary struct containing fields for encoding or decoding
+	// arguments. See https://pkg.go.dev/encoding/xml@go1.17.1#Marshal and
+	// https://pkg.go.dev/encoding/xml@go1.17.1#Unmarshal for details on
+	// annotating fields in the structure.
+	Args interface{} `xml:",any"`
+}
+
 // Write marshals a SOAP envelope to the writer. Errors can be from the writer
 // or XML encoding.
 func Write(w io.Writer, action *Action) error {
 	// Experiments with one router have shown that it 500s for requests where
 	// the outer default xmlns is set to the SOAP namespace, and then
 	// reassigning the default namespace within that to the service namespace.
-	// Most of the code in this function is hand-coding the outer XML to work
-	// around this.
+	// Most of the code in this function is hand-coding the outer XML to
+	// workaround this.
+	// Resolving https://github.com/golang/go/issues/9519 might remove the need
+	// for this workaround.
 
 	_, err := w.Write(envOpen)
 	if err != nil {
@@ -122,8 +139,3 @@ type body struct {
 	Fault  *Fault  `xml:"Fault"`
 	Action *Action `xml:",any"`
 }
-
-type Action struct {
-	XMLName xml.Name
-	Args    interface{} `xml:",any"`
-}

v2/soap/envelope/envelope_test.go

@@ -24,17 +24,55 @@ func TestWriteRead(t *testing.T) {
 	buf := &bytes.Buffer{}
 	err := Write(buf, sendAction)
 	if err != nil {
-		t.Errorf("EncodeEnvelope want success, got err=%v", err)
+		t.Errorf("Write want success, got err=%v", err)
 	}
 
 	recvAction := &Action{Args: &Args{}}
 
 	err = Read(buf, recvAction)
 	if err != nil {
-		t.Errorf("Reading envelope want success, got err=%v", err)
+		t.Errorf("Read want success, got err=%v", err)
 	}
 
 	if !reflect.DeepEqual(sendAction, recvAction) {
 		t.Errorf("want recvAction=%+v, got %+v", sendAction, recvAction)
 	}
 }
+
+func TestReadFault(t *testing.T) {
+	env := []byte(xml.Header + `
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
+s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+<s:Body>
+<s:Fault>
+<faultcode>dummy code</faultcode>
+<faultstring>dummy string</faultstring>
+<faultactor>dummy actor</faultactor>
+<detail>dummy detail</detail>
+</s:Fault>
+</s:Body>
+</s:Envelope>
+`)
+
+	type args struct{}
+
+	err := Read(bytes.NewBuffer(env), &Action{Args: &args{}})
+	if err == nil {
+		t.Fatal("want err != nil, got nil")
+	}
+
+	gotFault, ok := err.(*Fault)
+	if !ok {
+		t.Fatalf("want *Fault, got %T", err)
+	}
+
+	wantFault := &Fault{
+		Code:   "dummy code",
+		String: "dummy string",
+		Actor:  "dummy actor",
+		Detail: FaultDetail{Raw: []byte("dummy detail")},
+	}
+	if !reflect.DeepEqual(wantFault, gotFault) {
+		t.Errorf("want %+v, got %+v", wantFault, gotFault)
+	}
+}