Merge branch 'ef-remove-redundant-ruby-spec-tests' into 'main'

Removes and refactors Ruby Spec tests into Go

See merge request https://gitlab.com/gitlab-org/gitlab-shell/-/merge_requests/1364

Merged-by: Igor Drozdov <idrozdov@gitlab.com>
Approved-by: Vasilii Iakliushin <viakliushin@gitlab.com>
Approved-by: Igor Drozdov <idrozdov@gitlab.com>
Co-authored-by: e_forbes <eforbes@gitlab.com>

Author: 2 people

cmd/gitlab-shell-authorized-principals-check/command/command_test.go

@@ -55,11 +55,29 @@ func TestParseSuccess(t *testing.T) {
 		expectError  bool
 	}{
 		{
-			desc:         "It parses authorized-principals command",
+			desc:         "it parses authorized-principals command",
 			executable:   &executable.Executable{Name: executable.AuthorizedPrincipalsCheck},
 			arguments:    []string{"key", "principal-1", "principal-2"},
 			expectedArgs: &commandargs.AuthorizedPrincipals{Arguments: []string{"key", "principal-1", "principal-2"}, KeyID: "key", Principals: []string{"principal-1", "principal-2"}},
 		},
+		{
+			desc:        "it fails when a principal is empty",
+			executable:  &executable.Executable{Name: executable.AuthorizedPrincipalsCheck},
+			arguments:   []string{"key", "principal-1", ""},
+			expectError: true,
+		},
+		{
+			desc:        "it fails when a key_id is empty",
+			executable:  &executable.Executable{Name: executable.AuthorizedPrincipalsCheck},
+			arguments:   []string{"", "principal-1"},
+			expectError: true,
+		},
+		{
+			desc:        "it fails when not enough arguments are present",
+			executable:  &executable.Executable{Name: executable.AuthorizedPrincipalsCheck},
+			arguments:   []string{"key"},
+			expectError: true,
+		},
 	}
 
 	for _, tc := range testCases {

cmd/gitlab-shell/command/command_test.go

@@ -1,7 +1,6 @@
 package command_test
 
 import (
-	"errors"
 	"testing"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
@@ -216,7 +215,7 @@ func TestFailingNew(t *testing.T) {
 		{
 			desc:          "Parsing environment failed",
 			executable:    gitlabShellExec,
-			expectedError: errors.New("Only SSH allowed"),
+			expectedError: commandargs.ErrOnlySSHAllowed,
 		},
 		{
 			desc:          "Unknown command given",

internal/command/commandargs/shell.go

@@ -3,6 +3,7 @@
 package commandargs
 
 import (
+	"errors"
 	"fmt"
 	"regexp"
 	"strings"
@@ -33,6 +34,12 @@ var (
 	GitCommands = []CommandType{LfsAuthenticate, UploadPack, ReceivePack, UploadArchive}
 )
 
+var (
+	// ErrOnlySSHAllowed - represents the error returned when the
+	// a non ssh connection is passed.
+	ErrOnlySSHAllowed = errors.New("Only SSH allowed")
+)
+
 // Shell represents a parsed shell command with its arguments and related information.
 type Shell struct {
 	Arguments           []string
@@ -62,7 +69,7 @@ func (s *Shell) GetArguments() []string {
 
 func (s *Shell) validate() error {
 	if !s.Env.IsSSHConnection {
-		return fmt.Errorf("Only SSH allowed") //nolint:stylecheck //message is customer facing
+		return ErrOnlySSHAllowed //nolint:stylecheck //message is customer facing
 	}
 
 	if err := s.ParseCommand(s.Env.OriginalCommand); err != nil {

internal/command/discover/discover_test.go

@@ -72,6 +72,22 @@ func TestExecute(t *testing.T) {
 			arguments:        &commandargs.Shell{GitlabUsername: "unknown"},
 			expectedUsername: "Anonymous",
 		},
+		{
+			desc: "with a known username - when other input is also given",
+			arguments: &commandargs.Shell{
+				Arguments:      []string{"foo"},
+				GitlabUsername: "alex-doe",
+			},
+			expectedUsername: "@alex-doe",
+		},
+		{
+			desc: "with a known key id - when other input is also given",
+			arguments: &commandargs.Shell{
+				Arguments:   []string{"2foo"},
+				GitlabKeyID: "1",
+			},
+			expectedUsername: "@alex-doe",
+		},
 	}
 
 	for _, tc := range testCases {