ci: add codespell job, fix existing warnings

The following warnings were fixed:

./variant.go:52: unambigously ==> unambiguously
./conn.go:172: useable ==> usable
./dbus_test.go:32: parm ==> param, pram, parma
./dbus_test.go:42: parm ==> param, pram, parma
./dbus_test.go:42: parm ==> param, pram, parma
./dbus_test.go:44: parm ==> param, pram, parma
./encoder_test.go:268: occured ==> occurred
./encoder_test.go:315: occured ==> occurred
./object_test.go:111: Catched ==> Caught
./sequential_handler_test.go:235: occured ==> occurred
./server_interfaces.go:66: incase ==> in case
./introspect/introspect.go:53: retured ==> returned

Signed-off-by: Kir Kolyshkin <[email protected]>

Author: kolyshkin

.github/workflows/test.yml

@@ -35,3 +35,13 @@ jobs:
 
     - name: Test
       run: go test ${{ matrix.race }} -v ./...
+
+  codespell:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: install deps
+      # Version of codespell bundled with Ubuntu is way old, so use pip.
+      run: pip install codespell
+    - name: run codespell
+      run: codespell

conn.go

@@ -169,7 +169,7 @@ func Connect(address string, opts ...ConnOption) (*Conn, error) {
 
 // SystemBusPrivate returns a new private connection to the system bus.
 // Note: this connection is not ready to use. One must perform Auth and Hello
-// on the connection before it is useable.
+// on the connection before it is usable.
 func SystemBusPrivate(opts ...ConnOption) (*Conn, error) {
 	return Dial(getSystemBusPlatformAddress(), opts...)
 }

dbus_test.go

@@ -29,7 +29,7 @@ func Test_VariantOfSlicePtr(t *testing.T) {
 	value := []TestStruct{{1, "1"}}
 	dest := []*TestStruct{}
 
-	parm := &Message{
+	param := &Message{
 		Type:  TypeMethodCall,
 		Flags: FlagNoAutoStart,
 		Headers: map[HeaderField]Variant{
@@ -39,9 +39,9 @@ func Test_VariantOfSlicePtr(t *testing.T) {
 		},
 		Body: []interface{}{value},
 	}
-	parm.Headers[FieldSignature] = MakeVariant(SignatureOf(parm.Body...))
+	param.Headers[FieldSignature] = MakeVariant(SignatureOf(param.Body...))
 	buf := new(bytes.Buffer)
-	err := parm.EncodeTo(buf, nativeEndian)
+	err := param.EncodeTo(buf, nativeEndian)
 	if err != nil {
 		t.Fatal(err)
 	}

encoder_test.go

@@ -265,7 +265,7 @@ func TestEncodeIntToNonCovertible(t *testing.T) {
 	err = Store(v, &out)
 	if err == nil {
 		t.Logf("%t\n", out)
-		t.Fatal("Type mismatch should have occured")
+		t.Fatal("Type mismatch should have occurred")
 	}
 }
 
@@ -312,7 +312,7 @@ func TestEncodeUintToNonCovertible(t *testing.T) {
 	var out bool
 	err = Store(v, &out)
 	if err == nil {
-		t.Fatal("Type mismatch should have occured")
+		t.Fatal("Type mismatch should have occurred")
 	}
 }
 

introspect/introspect.go

@@ -50,7 +50,7 @@ type Interface struct {
 	Annotations []Annotation `xml:"annotation"`
 }
 
-// Method describes a Method on an Interface as retured by an introspection.
+// Method describes a Method on an Interface as returned by an introspection.
 type Method struct {
 	Name        string       `xml:"name,attr"`
 	Args        []Arg        `xml:"arg"`

object_test.go

@@ -108,7 +108,7 @@ func TestObjectSignalHandling(t *testing.T) {
 	go func() {
 		defer func() {
 			if err := recover(); err != nil {
-				t.Errorf("Catched panic in emitter goroutine: %v", err)
+				t.Errorf("Caught panic in emitter goroutine: %v", err)
 			}
 		}()
 

sequential_handler_test.go

@@ -232,7 +232,7 @@ func readSignals(t *testing.T, channel <-chan *Signal, count int) error {
 				return fmt.Errorf("Received signal out of order. Expected %v, got %v", i, signal.Sequence)
 			}
 		case <-ctx.Done():
-			return errors.New("Timeout occured before all messages received")
+			return errors.New("Timeout occurred before all messages received")
 		}
 	}
 	return nil

server_interfaces.go

@@ -63,7 +63,7 @@ type Method interface {
 // any other decoding scheme.
 type ArgumentDecoder interface {
 	// To decode the arguments of a method the sender and message are
-	// provided incase the semantics of the implementer provides access
+	// provided in case the semantics of the implementer provides access
 	// to these as part of the method invocation.
 	DecodeArguments(conn *Conn, sender string, msg *Message, args []interface{}) ([]interface{}, error)
 }

variant.go

@@ -49,7 +49,7 @@ func ParseVariant(s string, sig Signature) (Variant, error) {
 }
 
 // format returns a formatted version of v and whether this string can be parsed
-// unambigously.
+// unambiguously.
 func (v Variant) format() (string, bool) {
 	switch v.sig.str[0] {
 	case 'b', 'i':