Revise inernal references in pkg components

The location of these functions caused a cross internal/pkg
reference, which made external SDK builds difficult. This removes
the internal components from the pkg components to ensure
proper pkg compatibility.

Author: jkatz

internal/apiserver/common.go

@@ -22,6 +22,7 @@ import (
 	"strings"
 
 	"github.com/crunchydata/postgres-operator/internal/config"
+	pgpassword "github.com/crunchydata/postgres-operator/internal/postgres/password"
 	crv1 "github.com/crunchydata/postgres-operator/pkg/apis/crunchydata.com/v1"
 	log "github.com/sirupsen/logrus"
 	kerrors "k8s.io/apimachinery/pkg/api/errors"
@@ -48,6 +49,9 @@ var (
 	ErrDBContainerNotFound = errors.New("\"database\" container not found in pod")
 	// ErrLabelInvalid indicates that a label is invalid
 	ErrLabelInvalid = errors.New("invalid label")
+	// ErrPasswordTypeInvalid is used when a string that's not included in
+	// PasswordTypeStrings is used
+	ErrPasswordTypeInvalid = errors.New("invalid password type. choices are (md5, scram-sha-256)")
 	// ErrStandbyNotAllowed contains the error message returned when an API call is not
 	// permitted because it involves a cluster that is in standby mode
 	ErrStandbyNotAllowed = errors.New("Action not permitted because standby mode is enabled")
@@ -58,6 +62,15 @@ var (
 		"Operator installation")
 )
 
+// passwordTypeStrings is a mapping of strings of password types to their
+// corresponding value of the structured password type
+var passwordTypeStrings = map[string]pgpassword.PasswordType{
+	"":              pgpassword.MD5,
+	"md5":           pgpassword.MD5,
+	"scram":         pgpassword.SCRAM,
+	"scram-sha-256": pgpassword.SCRAM,
+}
+
 func CreateRMDataTask(clusterName, replicaName, taskName string, deleteBackups, deleteData, isReplica, isBackup bool, ns, clusterPGHAScope string) error {
 	var err error
 
@@ -100,6 +113,18 @@ func GetBackrestStorageTypes() []string {
 	return backrestStorageTypes
 }
 
+// GetPasswordType returns the enumerated password type based on the string, and
+// an error if it cannot match one
+func GetPasswordType(passwordTypeStr string) (pgpassword.PasswordType, error) {
+	passwordType, ok := passwordTypeStrings[passwordTypeStr]
+
+	if !ok {
+		return passwordType, ErrPasswordTypeInvalid
+	}
+
+	return passwordType, nil
+}
+
 // IsValidPVC determines if a PVC with the name provided exits
 func IsValidPVC(pvcName, ns string) bool {
 	pvc, err := Clientset.CoreV1().PersistentVolumeClaims(ns).Get(pvcName, metav1.GetOptions{})

internal/apiserver/common_test.go

@@ -21,9 +21,51 @@ import (
 	"strings"
 	"testing"
 
+	pgpassword "github.com/crunchydata/postgres-operator/internal/postgres/password"
+
 	"k8s.io/apimachinery/pkg/api/resource"
 )
 
+func TestGetPasswordType(t *testing.T) {
+	t.Run("valid", func(t *testing.T) {
+		tests := map[string]pgpassword.PasswordType{
+			"":              pgpassword.MD5,
+			"md5":           pgpassword.MD5,
+			"scram":         pgpassword.SCRAM,
+			"scram-sha-256": pgpassword.SCRAM,
+		}
+
+		for passwordTypeStr, expected := range tests {
+			t.Run(passwordTypeStr, func(t *testing.T) {
+				passwordType, err := GetPasswordType(passwordTypeStr)
+				if err != nil {
+					t.Error(err)
+					return
+				}
+
+				if passwordType != expected {
+					t.Errorf("password type %q should yield %d", passwordTypeStr, expected)
+				}
+			})
+		}
+	})
+
+	t.Run("invalid", func(t *testing.T) {
+		tests := map[string]error{
+			"magic":         ErrPasswordTypeInvalid,
+			"scram-sha-512": ErrPasswordTypeInvalid,
+		}
+
+		for passwordTypeStr, expected := range tests {
+			t.Run(passwordTypeStr, func(t *testing.T) {
+				if _, err := GetPasswordType(passwordTypeStr); !errors.Is(err, expected) {
+					t.Errorf("password type %q should yield error %q", passwordTypeStr, expected.Error())
+				}
+			})
+		}
+	})
+}
+
 func TestValidateLabel(t *testing.T) {
 	t.Run("valid", func(t *testing.T) {
 		inputs := []map[string]string{

internal/apiserver/userservice/userimpl.go

@@ -168,8 +168,7 @@ func CreateUser(request *msgs.CreateUserRequest, pgouser string) msgs.CreateUser
 	}
 
 	// determine if the user passed in a valid password type
-	passwordType, err := msgs.GetPasswordType(request.PasswordType)
-
+	passwordType, err := apiserver.GetPasswordType(request.PasswordType)
 	if err != nil {
 		response.Status.Code = msgs.Error
 		response.Status.Msg = err.Error()
@@ -620,7 +619,7 @@ func UpdateUser(request *msgs.UpdateUserRequest, pgouser string) msgs.UpdateUser
 	}
 
 	// determine if the user passed in a valid password type
-	if _, err := msgs.GetPasswordType(request.PasswordType); err != nil {
+	if _, err := apiserver.GetPasswordType(request.PasswordType); err != nil {
 		response.Status.Code = msgs.Error
 		response.Status.Msg = err.Error()
 		return response
@@ -965,7 +964,7 @@ func rotateExpiredPasswords(request *msgs.UpdateUserRequest, cluster *crv1.Pgclu
 
 		// get the password type. the error is already evaluated in a called
 		// function
-		passwordType, _ := msgs.GetPasswordType(request.PasswordType)
+		passwordType, _ := apiserver.GetPasswordType(request.PasswordType)
 
 		// generate a new password. Check to see if the user passed in a particular
 		// length of the password, or passed in a password to rotate (though that
@@ -1097,7 +1096,7 @@ func updateUser(request *msgs.UpdateUserRequest, cluster *crv1.Pgcluster) msgs.U
 	// Speaking of passwords...let's first determine if the user updated their
 	// password. See generatePassword for how precedence is given for password
 	// updates
-	passwordType, _ := msgs.GetPasswordType(request.PasswordType)
+	passwordType, _ := apiserver.GetPasswordType(request.PasswordType)
 	isChanged, password, hashedPassword, err := generatePassword(result.Username,
 		request.Password, passwordType, request.RotatePassword, request.PasswordLength)
 

pgo/cmd/user.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/crunchydata/postgres-operator/internal/apiserver"
 	utiloperator "github.com/crunchydata/postgres-operator/internal/util"
 	"github.com/crunchydata/postgres-operator/pgo/api"
 	"github.com/crunchydata/postgres-operator/pgo/util"
@@ -88,7 +89,7 @@ func createUser(args []string, ns string) {
 	}
 
 	// determine if the user provies a valid password type
-	if _, err := msgs.GetPasswordType(PasswordType); err != nil {
+	if _, err := apiserver.GetPasswordType(PasswordType); err != nil {
 		fmt.Println("Error:", err.Error())
 		os.Exit(1)
 	}
@@ -401,7 +402,7 @@ func updateUser(clusterNames []string, namespace string) {
 	}
 
 	// determine if the user provies a valid password type
-	if _, err := msgs.GetPasswordType(PasswordType); err != nil {
+	if _, err := apiserver.GetPasswordType(PasswordType); err != nil {
 		fmt.Println("Error:", err.Error())
 		os.Exit(1)
 	}

pkg/apiservermsgs/configmsgs.go

@@ -15,13 +15,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import (
-	"github.com/crunchydata/postgres-operator/internal/config"
-)
-
 // ShowConfigResponse ...
 // swagger:model
 type ShowConfigResponse struct {
-	Result config.PgoConfig
+	Result interface{}
 	Status
 }

pkg/apiservermsgs/usermsgs.go

@@ -15,12 +15,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import (
-	"errors"
-
-	pgpassword "github.com/crunchydata/postgres-operator/internal/postgres/password"
-)
-
 type UpdateClusterLoginState int
 
 // set the different values around whether or not to disable/enable a user's
@@ -31,21 +25,6 @@ const (
 	UpdateUserLoginDisable
 )
 
-var (
-	// ErrPasswordTypeInvalid is used when a string that's not included in
-	// PasswordTypeStrings is used
-	ErrPasswordTypeInvalid = errors.New("invalid password type. choices are (md5, scram-sha-256)")
-)
-
-// passwordTypeStrings is a mapping of strings of password types to their
-// corresponding value of the structured password type
-var passwordTypeStrings = map[string]pgpassword.PasswordType{
-	"":              pgpassword.MD5,
-	"md5":           pgpassword.MD5,
-	"scram":         pgpassword.SCRAM,
-	"scram-sha-256": pgpassword.SCRAM,
-}
-
 // CreateUserRequest contains the parameters that are passed in when an Operator
 // user requests to create a new PostgreSQL user
 // swagger:model
@@ -152,15 +131,3 @@ type UserResponseDetail struct {
 	Username     string
 	ValidUntil   string
 }
-
-// GetPasswordType returns the enumerated password type based on the string, and
-// an error if it cannot match one
-func GetPasswordType(passwordTypeStr string) (pgpassword.PasswordType, error) {
-	passwordType, ok := passwordTypeStrings[passwordTypeStr]
-
-	if !ok {
-		return passwordType, ErrPasswordTypeInvalid
-	}
-
-	return passwordType, nil
-}

pkg/apiservermsgs/usermsgs_test.go

@@ -19,18 +19,16 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	crunchylog "github.com/crunchydata/postgres-operator/internal/logging"
-	"github.com/nsqio/go-nsq"
-	log "github.com/sirupsen/logrus"
 	"os"
 	"reflect"
 	"time"
+
+	"github.com/nsqio/go-nsq"
+	log "github.com/sirupsen/logrus"
 )
 
 // String returns the string form for a given LogLevel
 func Publish(e EventInterface) error {
-	//Add logging configuration
-	crunchylog.CrunchyLogger(crunchylog.SetParameters())
 	eventAddr := os.Getenv("EVENT_ADDR")
 	if eventAddr == "" {
 		return errors.New("EVENT_ADDR not set")