Rename structs, add periods to comments and update AuthToken comment

cmd/authtoken/main.go

@@ -22,8 +22,8 @@ var (
 	configPath string
 )
 
-func parseArgs() (authtoken.AuthTokenProvider, error) {
-	var tokenProvider authtoken.AuthTokenProvider
+func parseArgs() (authtoken.Provider, error) {
+	var tokenProvider authtoken.Provider
 	rootCmd := &cobra.Command{Use: "refreshtoken", Args: cobra.NoArgs}
 	rootCmd.PersistentFlags().StringVar(&configPath, "file-path", "/config/token", "token file path")
 

pkg/authtoken/interfaces.go

@@ -9,22 +9,22 @@ import (
 	"time"
 )
 
-// An AuthToken is an authorization token for the fleet
+// An AuthToken is an authentication token used to communicate with the hub API server.
 type AuthToken struct {
 	Token     string    // name of token
 	ExpiresOn time.Time // expiration time of token
 }
 
-// AuthTokenProvider defines a method for fetching an AuthToken
-type AuthTokenProvider interface {
-	// FetchToken fetches an AuthToken
-	// It returns an error if it is unable to fetch an AuthToken for the given input context
+// Provider defines a method for fetching an AuthToken.
+type Provider interface {
+	// FetchToken fetches an AuthToken.
+	// It returns an error if it is unable to fetch an AuthToken for the given input context.
 	FetchToken(ctx context.Context) (AuthToken, error)
 }
 
-// AuthTokenWriter defines a method for writing an AuthToken
-type AuthTokenWriter interface {
-	// WriteToken writes an AuthToken
-	// It returns an error if it is unable to write the AuthToken
+// Writer defines a method for writing an AuthToken.
+type Writer interface {
+	// WriteToken writes an AuthToken.
+	// It returns an error if it is unable to write the AuthToken.
 	WriteToken(token AuthToken) error
 }

pkg/authtoken/providers/azure/azure_msi.go

@@ -25,7 +25,7 @@ type AuthTokenProvider struct {
 	Scope    string
 }
 
-func New(clientID, scope string) authtoken.AuthTokenProvider {
+func New(clientID, scope string) authtoken.Provider {
 	if scope == "" {
 		scope = aksScope
 	}

pkg/authtoken/providers/secret/k8s_secret.go

@@ -28,7 +28,7 @@ type secretAuthTokenProvider struct {
 	secretNamespace string
 }
 
-func New(secretName, namespace string) (authtoken.AuthTokenProvider, error) {
+func New(secretName, namespace string) (authtoken.Provider, error) {
 	client, err := getClient()
 	if err != nil {
 		return nil, fmt.Errorf("an error occurred will creating client: %w", err)

pkg/authtoken/token_refresher.go

@@ -16,14 +16,14 @@ type RefreshDurationFuncType func(token AuthToken) time.Duration
 type CreateTickerFuncType func(time.Duration) <-chan time.Time
 
 type Refresher struct {
-	provider         AuthTokenProvider
-	writer           AuthTokenWriter
+	provider         Provider
+	writer           Writer
 	refreshCalculate RefreshDurationFuncType
 	createTicker     CreateTickerFuncType
 }
 
-func NewAuthTokenRefresher(tokenProvider AuthTokenProvider,
-	writer AuthTokenWriter,
+func NewAuthTokenRefresher(tokenProvider Provider,
+	writer Writer,
 	refreshCalculate RefreshDurationFuncType,
 	createTicker CreateTickerFuncType) *Refresher {
 	return &Refresher{

pkg/authtoken/token_writer.go

@@ -28,17 +28,17 @@ func (w Factory) Create() (io.WriteCloser, error) {
 	return wc, nil
 }
 
-type Writer struct {
+type TokenWriter struct {
 	writerFactory func() (io.WriteCloser, error)
 }
 
-func NewWriter(factory func() (io.WriteCloser, error)) AuthTokenWriter {
-	return &Writer{
+func NewWriter(factory func() (io.WriteCloser, error)) Writer {
+	return &TokenWriter{
 		writerFactory: factory,
 	}
 }
 
-func (w *Writer) WriteToken(token AuthToken) error {
+func (w *TokenWriter) WriteToken(token AuthToken) error {
 	writer, err := w.writerFactory()
 	if err != nil {
 		return err