Use enumer to generate String() methods for most enums (#25705) (#26469)

We have many hand-written String() methods (and similar) for enums. These require more maintenance and are more error-prone than using automatically generated methods. In addition, the auto-generated versions can be more efficient. Here, we switch to using https://github.com/loggerhead/enumer, itself a fork of https://github.com/diegostamigni/enumer, no longer maintained, and a fork of the mostly standard tool https://pkg.go.dev/golang.org/x/tools/cmd/stringer. We use this fork of enumer for Go 1.20+ compatibility and because we require the `-transform` flag to be able to generate constants that match our current code base. Some enums were not targeted for this change: Co-authored-by: Christopher Swenson <[email protected]>
hashicorp · Apr 18, 2024 · b2e6565 · b2e6565
1 parent 589ae73
commit b2e6565
Show file tree

Hide file tree

Showing 55 changed files with 1,353 additions and 146 deletions.
diff --git a/.github/actions/build-vault/action.yml b/.github/actions/build-vault/action.yml
@@ -86,6 +86,7 @@ runs:
     - uses: ./.github/actions/set-up-go
       with:
         github-token: ${{ inputs.github-token }}
+    - uses: ./.github/actions/install-external-tools
     - if: inputs.vault-edition != 'ce'
       name: Configure Git
       shell: bash

diff --git a/.github/actions/install-external-tools/action.yml b/.github/actions/install-external-tools/action.yml
@@ -30,3 +30,5 @@ runs:
       shell: bash
     - run: go install github.com/golangci/revgrep/cmd/revgrep@latest
       shell: bash
+    - run: go install github.com/loggerhead/enumer@latest
+      shell: bash
diff --git a/api/lifetime_watcher.go b/api/lifetime_watcher.go
@@ -31,6 +31,7 @@ var (
 	DefaultRenewerRenewBuffer = 5
 )
 
+//go:generate enumer -type=RenewBehavior -trimprefix=RenewBehavior
 type RenewBehavior uint
 
 const (

diff --git a/api/plugin_runtime_types.go b/api/plugin_runtime_types.go
@@ -9,11 +9,9 @@ package api
 
 import "fmt"
 
-var PluginRuntimeTypes = []PluginRuntimeType{
-	PluginRuntimeTypeUnsupported,
-	PluginRuntimeTypeContainer,
-}
+var PluginRuntimeTypes = _PluginRuntimeTypeValues
 
+//go:generate enumer -type=PluginRuntimeType -trimprefix=PluginRuntimeType -transform=snake
 type PluginRuntimeType uint32
 
 // This is a list of PluginRuntimeTypes used by Vault.
@@ -22,20 +20,11 @@ const (
 	PluginRuntimeTypeContainer
 )
 
-func (r PluginRuntimeType) String() string {
-	switch r {
-	case PluginRuntimeTypeContainer:
-		return "container"
-	default:
-		return "unsupported"
-	}
-}
-
+// ParsePluginRuntimeType is a wrapper around PluginRuntimeTypeString kept for backwards compatibility.
 func ParsePluginRuntimeType(PluginRuntimeType string) (PluginRuntimeType, error) {
-	switch PluginRuntimeType {
-	case "container":
-		return PluginRuntimeTypeContainer, nil
-	default:
+	t, err := PluginRuntimeTypeString(PluginRuntimeType)
+	if err != nil {
 		return PluginRuntimeTypeUnsupported, fmt.Errorf("%q is not a supported plugin runtime type", PluginRuntimeType)
 	}
+	return t, nil
 }
diff --git a/api/pluginruntimetype_enumer.go b/api/pluginruntimetype_enumer.go
diff --git a/api/renewbehavior_enumer.go b/api/renewbehavior_enumer.go
diff --git a/builtin/logical/pki/defaultdirectorypolicytype_enumer.go b/builtin/logical/pki/defaultdirectorypolicytype_enumer.go
diff --git a/builtin/logical/pki/ifmodifiedreqtype_enumer.go b/builtin/logical/pki/ifmodifiedreqtype_enumer.go
diff --git a/builtin/logical/pki/path_config_acme.go b/builtin/logical/pki/path_config_acme.go
@@ -394,6 +394,7 @@ func getDefaultDirectoryPolicyType(defaultDirectoryPolicy string) (DefaultDirect
 	}
 }
 
+//go:generate enumer -type=DefaultDirectoryPolicyType
 type DefaultDirectoryPolicyType int
 
 const (

diff --git a/builtin/logical/pki/path_tidy.go b/builtin/logical/pki/path_tidy.go
@@ -23,15 +23,16 @@ import (
 
 var tidyCancelledError = errors.New("tidy operation cancelled")
 
+//go:generate enumer -type=tidyStatusState -trimprefix=tidyStatus
 type tidyStatusState int
 
 const (
-	tidyStatusInactive   tidyStatusState = iota
-	tidyStatusStarted                    = iota
-	tidyStatusFinished                   = iota
-	tidyStatusError                      = iota
-	tidyStatusCancelling                 = iota
-	tidyStatusCancelled                  = iota
+	tidyStatusInactive tidyStatusState = iota
+	tidyStatusStarted
+	tidyStatusFinished
+	tidyStatusError
+	tidyStatusCancelling
+	tidyStatusCancelled
 )
 
 type tidyStatus struct {

diff --git a/builtin/logical/pki/tidystatusstate_enumer.go b/builtin/logical/pki/tidystatusstate_enumer.go
diff --git a/builtin/logical/pki/util.go b/builtin/logical/pki/util.go
@@ -254,15 +254,16 @@ func parseIfNotModifiedSince(req *logical.Request) (time.Time, error) {
 	return headerTimeValue, nil
 }
 
+//go:generate enumer -type=ifModifiedReqType -trimprefix=ifModified
 type ifModifiedReqType int
 
 const (
-	ifModifiedUnknown         ifModifiedReqType = iota
-	ifModifiedCA                                = iota
-	ifModifiedCRL                               = iota
-	ifModifiedDeltaCRL                          = iota
-	ifModifiedUnifiedCRL                        = iota
-	ifModifiedUnifiedDeltaCRL                   = iota
+	ifModifiedUnknown ifModifiedReqType = iota
+	ifModifiedCA
+	ifModifiedCRL
+	ifModifiedDeltaCRL
+	ifModifiedUnifiedCRL
+	ifModifiedUnifiedDeltaCRL
 )
 
 type IfModifiedSinceHelper struct {
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,7 @@ var ( @@
     	DefaultRenewerRenewBuffer = 5
     )
+    //go:generate enumer -type=RenewBehavior -trimprefix=RenewBehavior
     type RenewBehavior uint
     const (
@@ Expand Down @@