From ff2854e9431d650e0d5a0f6be42d087793de9e05 Mon Sep 17 00:00:00 2001 From: Joshua Spence Date: Fri, 24 Sep 2021 13:55:12 +1000 Subject: [PATCH] Implement `Stringer` interface for `DeviceState` (#49) * Implement `Stringer` interface for `DeviceState` If device adoption fails the error message isn't very readable at the moment. ``` Error: unexpected state '10', wanted target '2'. ``` * Use `stringer` --- .github/workflows/ci.yaml | 2 ++ go.mod | 1 + go.sum | 27 +++++++++++++++++++++++++++ tools.go | 7 +++++++ unifi/device.go | 1 + unifi/devicestate_string.go | 34 ++++++++++++++++++++++++++++++++++ 6 files changed, 72 insertions(+) create mode 100644 tools.go create mode 100644 unifi/devicestate_string.go diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 3e61bb7..db2ec31 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -42,6 +42,8 @@ jobs: - uses: "actions/setup-go@v2" with: go-version: "${{ env.GO_VERSION }}" + - run: "go get golang.org/x/tools/cmd/stringer" + - run: "go generate ./..." - run: "git diff --compact-summary --exit-code" diff --git a/go.mod b/go.mod index 68f03d7..06da2a5 100644 --- a/go.mod +++ b/go.mod @@ -11,5 +11,6 @@ require ( github.com/tj/assert v0.0.3 github.com/ulikunitz/xz v0.5.10 github.com/xor-gate/ar v0.0.0-20170530204233-5c72ae81e2b7 + golang.org/x/tools v0.1.6 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect ) diff --git a/go.sum b/go.sum index 9e66dbd..f578e07 100644 --- a/go.sum +++ b/go.sum @@ -22,6 +22,33 @@ github.com/ulikunitz/xz v0.5.10 h1:t92gobL9l3HE202wg3rlk19F6X+JOxl9BBrCCMYEYd8= github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= github.com/xor-gate/ar v0.0.0-20170530204233-5c72ae81e2b7 h1:Vo3q7h44BfmnLQh5SdF+2xwIoVnHThmZLunx6odjrHI= github.com/xor-gate/ar v0.0.0-20170530204233-5c72ae81e2b7/go.mod h1:TCWCUPhQU1j7axqROa/VHnlgJGHthAOqJZahg7b/DUc= +github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5DUVem42yDJZZ4CNxMA= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.6 h1:SIasE1FVIQOWz2GEAHFOmoW7xchJcqlucjSULTL0Ag4= +golang.org/x/tools v0.1.6/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/tools.go b/tools.go new file mode 100644 index 0000000..ace5f40 --- /dev/null +++ b/tools.go @@ -0,0 +1,7 @@ +// +build tools + +package main + +import ( + _ "golang.org/x/tools/cmd/stringer" +) \ No newline at end of file diff --git a/unifi/device.go b/unifi/device.go index 53fbf0d..2fded70 100644 --- a/unifi/device.go +++ b/unifi/device.go @@ -5,6 +5,7 @@ import ( "fmt" ) +//go:generate stringer -trimprefix DeviceState -type DeviceState type DeviceState int const ( diff --git a/unifi/devicestate_string.go b/unifi/devicestate_string.go new file mode 100644 index 0000000..97b2d07 --- /dev/null +++ b/unifi/devicestate_string.go @@ -0,0 +1,34 @@ +// Code generated by "stringer -trimprefix DeviceState -type DeviceState"; DO NOT EDIT. + +package unifi + +import "strconv" + +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[DeviceStateUnknown-0] + _ = x[DeviceStateConnected-1] + _ = x[DeviceStatePending-2] + _ = x[DeviceStateFirmwareMismatch-3] + _ = x[DeviceStateUpgrading-4] + _ = x[DeviceStateProvisioning-5] + _ = x[DeviceStateHeartbeatMissed-6] + _ = x[DeviceStateAdopting-7] + _ = x[DeviceStateDeleting-8] + _ = x[DeviceStateInformError-9] + _ = x[DeviceStateAdoptFailed-10] + _ = x[DeviceStateIsolated-11] +} + +const _DeviceState_name = "UnknownConnectedPendingFirmwareMismatchUpgradingProvisioningHeartbeatMissedAdoptingDeletingInformErrorAdoptFailedIsolated" + +var _DeviceState_index = [...]uint8{0, 7, 16, 23, 39, 48, 60, 75, 83, 91, 102, 113, 121} + +func (i DeviceState) String() string { + if i < 0 || i >= DeviceState(len(_DeviceState_index)-1) { + return "DeviceState(" + strconv.FormatInt(int64(i), 10) + ")" + } + return _DeviceState_name[_DeviceState_index[i]:_DeviceState_index[i+1]] +}