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

cmd/pgo/cmd/user.go

@@ -22,6 +22,7 @@ import (
 
 "github.com/crunchydata/postgres-operator/cmd/pgo/api"
 "github.com/crunchydata/postgres-operator/cmd/pgo/util"
+"github.com/crunchydata/postgres-operator/internal/apiserver"
 utiloperator "github.com/crunchydata/postgres-operator/internal/util"
 msgs "github.com/crunchydata/postgres-operator/pkg/apiservermsgs"
 
@@ -89,7 +90,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)
 }
@@ -400,7 +401,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)
 }

internal/apiserver/common.go

@@ -21,6 +21,7 @@ import (
 "fmt"
 "strings"
 
+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"
@@ -44,6 +45,9 @@ var (
 // ErrDBContainerNotFound is an error that indicates that a "database" container
 // could not be found in a specific pod
 ErrDBContainerNotFound = errors.New("\"database\" container not found in pod")
+// 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")
@@ -54,6 +58,27 @@ 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,
+}
+
+// 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 {
 ctx := context.TODO()

internal/apiserver/common_test.go

@@ -16,13 +16,55 @@ limitations under the License.
 */
 
 import (
+"errors"
 "testing"
 
+pgpassword "github.com/crunchydata/postgres-operator/internal/postgres/password"
 crv1 "github.com/crunchydata/postgres-operator/pkg/apis/crunchydata.com/v1"
 
 "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 TestValidateBackrestStorageTypeForCommand(t *testing.T) {
 cluster := &crv1.Pgcluster{
 Spec: crv1.PgclusterSpec{},

internal/apiserver/userservice/userimpl.go

@@ -155,7 +155,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()
@@ -601,7 +601,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
@@ -940,7 +940,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
@@ -1072,7 +1072,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)
 // in the off-chance there is an error generating the password, record it

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,19 +25,6 @@ const (
 UpdateUserLoginDisable
 )
 
-// ErrPasswordTypeInvalid is used when a string that's not included in
-// PasswordTypeStrings is used
-var 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
@@ -153,15 +134,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

@@ -23,15 +23,12 @@ import (
 "reflect"
 "time"
 
-crunchylog "github.com/crunchydata/postgres-operator/internal/logging"
 "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")