Improve repositores code

Signed-off-by: Michael Sverdlov <[email protected]>

Author: sverdlov93

artifactory/commands/npm/login.go

@@ -0,0 +1,69 @@
+package npm
+
+import (
+	"github.com/jfrog/gofrog/version"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/repository"
+	cmdutils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/common/project"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
+	"github.com/jfrog/jfrog-client-go/artifactory/services"
+	"github.com/jfrog/jfrog-client-go/utils/log"
+)
+
+type NpmLoginCommand struct {
+	commandName    string
+	npmVersion     *version.Version
+	repoUrl        string
+	executablePath string
+	CommonArgs
+}
+
+func NewNpmLoginCommand() *NpmLoginCommand {
+	return &NpmLoginCommand{commandName: "rt_npm_login"}
+}
+
+// Run configures npm to use the specified or selected JFrog Artifactory repository
+// for package management, setting up registry and authentication.
+func (nlc *NpmLoginCommand) Run() (err error) {
+	// If no repository is specified, prompt the user to select an npm-compatible repository.
+	if nlc.repo == "" {
+		// Define filter parameters to select virtual repositories of npm package type.
+		repoFilterParams := services.RepositoriesFilterParams{
+			RepoType:    utils.Virtual.String(),
+			PackageType: repository.Npm,
+		}
+
+		// Select repository interactively based on filter parameters and server details.
+		nlc.repo, err = utils.SelectRepositoryInteractively(nlc.serverDetails, repoFilterParams)
+		if err != nil {
+			return err
+		}
+	}
+
+	// Initialize NpmrcYarnrcManager for npm to manage registry and authentication configurations.
+	npmrcManager := cmdutils.NewNpmrcYarnrcManager(project.Npm, nlc.repo, nlc.serverDetails)
+
+	// Configure the registry URL for npm in the npm configuration.
+	if err = npmrcManager.ConfigureRegistry(); err != nil {
+		return err
+	}
+
+	// Configure authentication settings, handling token or basic auth as needed.
+	if err = npmrcManager.ConfigureAuth(); err != nil {
+		return err
+	}
+
+	// Output success message indicating successful npm configuration.
+	log.Output(coreutils.PrintTitle("Successfully configured npm client to work with your JFrog Artifactory repository: " + nlc.repo))
+	return nil
+}
+
+func (nlc *NpmLoginCommand) CommandName() string {
+	return nlc.commandName
+}
+
+func (nlc *NpmLoginCommand) ServerDetails() (*config.ServerDetails, error) {
+	return nlc.serverDetails, nil
+}

artifactory/commands/npm/login_test.go

@@ -0,0 +1,89 @@
+package npm
+
+import (
+	"fmt"
+	cmdutils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestNpmLoginCommand(t *testing.T) {
+	// Create a temporary directory to act as the environment's npmrc file location.
+	tempDir := t.TempDir()
+	npmrcFilePath := filepath.Join(tempDir, ".npmrc")
+
+	// Set NPM_CONFIG_USERCONFIG to point to the temporary npmrc file path.
+	t.Setenv("NPM_CONFIG_USERCONFIG", npmrcFilePath)
+
+	// Initialize a new NpmLoginCommand instance.
+	loginCmd := NewNpmLoginCommand()
+	loginCmd.SetServerDetails(&config.ServerDetails{ArtifactoryUrl: "https://acme.jfrog.io/artifactory"})
+	loginCmd.repo = "npm-virtual"
+
+	// Define test cases for different authentication types.
+	testCases := []struct {
+		name        string
+		user        string
+		password    string
+		accessToken string
+	}{
+		{
+			name:        "Token Authentication",
+			accessToken: "test-token",
+		},
+		{
+			name:     "Basic Authentication",
+			user:     "myUser",
+			password: "myPassword",
+		},
+		{
+			name: "Anonymous Access",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			// Set up server details for the current test case's authentication type.
+			loginCmd.serverDetails.SetUser(testCase.user)
+			loginCmd.serverDetails.SetPassword(testCase.password)
+			loginCmd.serverDetails.SetAccessToken(testCase.accessToken)
+
+			// Run the login command and ensure no errors occur.
+			assert.NoError(t, loginCmd.Run())
+
+			// Read the contents of the temporary npmrc file.
+			npmrcContentBytes, err := os.ReadFile(npmrcFilePath)
+			assert.NoError(t, err)
+			npmrcContent := string(npmrcContentBytes)
+
+			// Validate that the registry URL was set correctly in .npmrc.
+			assert.Contains(t, npmrcContent, fmt.Sprintf("%s=%s", cmdutils.NpmConfigRegistryKey, "https://acme.jfrog.io/artifactory/api/npm/npm-virtual"))
+
+			// Define expected keys for basic and token auth in the .npmrc.
+			basicAuthKey := fmt.Sprintf("//acme.jfrog.io/artifactory/api/npm/npm-virtual:%s=", cmdutils.NpmConfigAuthKey)
+			tokenAuthKey := fmt.Sprintf("//acme.jfrog.io/artifactory/api/npm/npm-virtual:%s=", cmdutils.NpmConfigAuthTokenKey)
+
+			switch {
+			// Validate token-based authentication.
+			case testCase.accessToken != "":
+				assert.Contains(t, npmrcContent, tokenAuthKey+"test-token")
+				assert.NotContains(t, npmrcContent, basicAuthKey)
+
+			// Validate basic authentication with encoded credentials.
+			case testCase.user != "" && testCase.password != "":
+				// Base64 encoding of "myUser:myPassword"
+				expectedBasicAuth := basicAuthKey + "\"bXlVc2VyOm15UGFzc3dvcmQ=\""
+				assert.Contains(t, npmrcContent, expectedBasicAuth)
+				assert.NotContains(t, npmrcContent, tokenAuthKey)
+
+			// Validate anonymous access, where neither auth method is configured.
+			default:
+				assert.NotContains(t, npmrcContent, basicAuthKey)
+				assert.NotContains(t, npmrcContent, tokenAuthKey)
+			}
+		})
+	}
+}

artifactory/commands/utils/npmcmdutils.go

@@ -1,26 +1,33 @@
 package utils
 
 import (
+	"encoding/base64"
 	"fmt"
-	outFormat "github.com/jfrog/jfrog-cli-core/v2/common/format"
-	"net/http"
-	"strings"
-
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils/npm"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils/yarn"
 	"github.com/jfrog/jfrog-cli-core/v2/common/build"
+	outFormat "github.com/jfrog/jfrog-cli-core/v2/common/format"
+	"github.com/jfrog/jfrog-cli-core/v2/common/project"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
 	"github.com/jfrog/jfrog-client-go/auth"
 	"github.com/jfrog/jfrog-client-go/http/httpclient"
 	clientutils "github.com/jfrog/jfrog-client-go/utils"
 	"github.com/jfrog/jfrog-client-go/utils/errorutils"
 	"github.com/jfrog/jfrog-client-go/utils/log"
+	"net/http"
+	"strings"
 )
 
 const (
 	minSupportedArtifactoryVersionForNpmCmds = "5.5.2"
-	NpmConfigAuthKey                         = "_auth"
-	NpmConfigAuthTokenKey                    = "_authToken"
-	npmAuthRestApi                           = "api/npm/auth"
+
+	NpmConfigAuthKey = "_auth"
+	// Supported only in npm version 9 and above.
+	NpmConfigAuthTokenKey = "_authToken"
+	NpmConfigRegistryKey  = "registry"
+	npmAuthRestApi        = "api/npm/auth"
 )
 
 // Constructs npm auth config and registry, manually or by requesting the Artifactory /npm/auth endpoint.
@@ -37,7 +44,7 @@ func GetArtifactoryNpmRepoDetails(repo string, authArtDetails auth.ServiceDetail
 		return "", "", err
 	}
 
-	registry = getNpmRepositoryUrl(repo, authArtDetails.GetUrl())
+	registry = GetNpmRepositoryUrl(repo, authArtDetails.GetUrl())
 	return
 }
 
@@ -59,7 +66,7 @@ func getNpmAuth(authArtDetails auth.ServiceDetails, isNpmAuthLegacyVersion bool)
 
 // Manually constructs the npm authToken config data.
 func constructNpmAuthToken(token string) string {
-	return fmt.Sprintf("%s = %s\nalways-auth = true", NpmConfigAuthTokenKey, token)
+	return fmt.Sprintf("%s = %s", NpmConfigAuthTokenKey, token)
 }
 
 func validateArtifactoryVersionForNpmCmds(artDetails auth.ServiceDetails) error {
@@ -93,12 +100,8 @@ func getNpmAuthFromArtifactory(artDetails auth.ServiceDetails) (npmAuth string,
 	return string(body), nil
 }
 
-func getNpmRepositoryUrl(repo, url string) string {
-	if !strings.HasSuffix(url, "/") {
-		url += "/"
-	}
-	url += "api/npm/" + repo
-	return url
+func GetNpmRepositoryUrl(repositoryName, artifactoryUrl string) string {
+	return strings.TrimSuffix(artifactoryUrl, "/") + "/api/npm/" + repositoryName
 }
 
 // Remove all the none npm CLI flags from args.
@@ -125,3 +128,120 @@ func ExtractNpmOptionsFromArgs(args []string) (detailedSummary, xrayScan bool, s
 	cleanArgs, buildConfig, err = build.ExtractBuildDetailsFromArgs(cleanArgs)
 	return
 }
+
+// NpmrcYarnrcManager is responsible for configuring npm and Yarn registries
+// and authentication settings based on the specified project type.
+type NpmrcYarnrcManager struct {
+	// buildTool represents the project type, either NPM or Yarn.
+	buildTool project.ProjectType
+	// repoUrl holds the URL to the npm or Yarn repository.
+	repoUrl string
+	// serverDetails contains configuration details for the Artifactory server.
+	serverDetails *config.ServerDetails
+}
+
+// NewNpmrcYarnrcManager initializes a new NpmrcYarnrcManager with the given project type,
+// repository name, and Artifactory server details.
+func NewNpmrcYarnrcManager(buildTool project.ProjectType, repoName string, serverDetails *config.ServerDetails) *NpmrcYarnrcManager {
+	repoUrl := GetNpmRepositoryUrl(repoName, serverDetails.ArtifactoryUrl)
+	return &NpmrcYarnrcManager{
+		buildTool:     buildTool,
+		repoUrl:       repoUrl,
+		serverDetails: serverDetails,
+	}
+}
+
+// ConfigureRegistry sets the registry URL in the npmrc or yarnrc file.
+func (nm *NpmrcYarnrcManager) ConfigureRegistry() error {
+	return nm.configSet(NpmConfigRegistryKey, nm.repoUrl)
+}
+
+// ConfigureAuth configures authentication in npmrc or yarnrc using token or basic auth,
+// or clears authentication for anonymous access.
+func (nm *NpmrcYarnrcManager) ConfigureAuth() error {
+	authArtDetails, err := nm.serverDetails.CreateArtAuthConfig()
+	if err != nil {
+		return err
+	}
+
+	// Configure authentication based on available credentials.
+	switch {
+	case authArtDetails.GetAccessToken() != "":
+		return nm.handleNpmrcTokenAuth(authArtDetails.GetAccessToken())
+	case authArtDetails.GetUser() != "" && authArtDetails.GetPassword() != "":
+		return nm.handleNpmrcBasicAuth(authArtDetails.GetUser(), authArtDetails.GetPassword())
+	default:
+		return nm.handleNpmAnonymousAccess()
+	}
+}
+
+// handleNpmrcTokenAuth sets the token in the npmrc or yarnrc file and clears basic auth if it exists.
+func (nm *NpmrcYarnrcManager) handleNpmrcTokenAuth(token string) error {
+	authKey := nm.createAuthKey(NpmConfigAuthTokenKey)
+	if err := nm.configSet(authKey, token); err != nil {
+		return err
+	}
+	return nm.removeNpmrcBasicAuthIfExists()
+}
+
+// handleNpmrcBasicAuth sets basic auth credentials and clears any token-based auth.
+func (nm *NpmrcYarnrcManager) handleNpmrcBasicAuth(user, password string) error {
+	authKey := nm.createAuthKey(NpmConfigAuthKey)
+	authValue := basicAuthBase64Encode(user, password)
+	if err := nm.configSet(authKey, authValue); err != nil {
+		return err
+	}
+	return nm.removeNpmrcTokenAuthIfExists()
+}
+
+// handleNpmAnonymousAccess removes any existing authentication settings for anonymous access.
+func (nm *NpmrcYarnrcManager) handleNpmAnonymousAccess() error {
+	if err := nm.removeNpmrcBasicAuthIfExists(); err != nil {
+		return err
+	}
+	return nm.removeNpmrcTokenAuthIfExists()
+}
+
+// removeNpmrcBasicAuthIfExists deletes basic auth credentials if present.
+func (nm *NpmrcYarnrcManager) removeNpmrcBasicAuthIfExists() error {
+	return nm.configDelete(nm.createAuthKey(NpmConfigAuthKey))
+}
+
+// removeNpmrcTokenAuthIfExists deletes token auth credentials if present.
+func (nm *NpmrcYarnrcManager) removeNpmrcTokenAuthIfExists() error {
+	return nm.configDelete(nm.createAuthKey(NpmConfigAuthTokenKey))
+}
+
+// configSet applies a configuration setting in npmrc or yarnrc, based on the build tool type.
+func (nm *NpmrcYarnrcManager) configSet(key, value string) error {
+	switch nm.buildTool {
+	case project.Npm:
+		return npm.ConfigSet(key, value, nm.buildTool.String())
+	case project.Yarn:
+		return yarn.ConfigSet(key, value, nm.buildTool.String(), false)
+	default:
+		return errorutils.CheckError(fmt.Errorf("unsupported build tool: %s", nm.buildTool))
+	}
+}
+
+// configDelete removes a configuration setting from npmrc or yarnrc, based on the build tool type.
+func (nm *NpmrcYarnrcManager) configDelete(key string) error {
+	switch nm.buildTool {
+	case project.Npm:
+		return npm.ConfigDelete(key, nm.buildTool.String())
+	case project.Yarn:
+		return yarn.ConfigDelete(key, nm.buildTool.String())
+	default:
+		return errorutils.CheckError(fmt.Errorf("unsupported build tool: %s", nm.buildTool))
+	}
+}
+
+// createAuthKey generates the correct authentication key for npm or Yarn, based on the repo URL.
+func (nm *NpmrcYarnrcManager) createAuthKey(keySuffix string) string {
+	return fmt.Sprintf("//%s:%s", strings.TrimPrefix(nm.repoUrl, "https://"), keySuffix)
+}
+
+// basicAuthBase64Encode encodes user credentials in Base64 for basic authentication.
+func basicAuthBase64Encode(user, password string) string {
+	return base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", user, password)))
+}