Skip to content

Commit

Permalink
Package Manager Setup command (Npm Pnpm Yarn Pip Pipenv `Po…
Browse files Browse the repository at this point in the history
…etry` `Go` `Nuget` `Dotnet` `Docker` `Podman` `Maven` `Gradle`) (#2738)
  • Loading branch information
sverdlov93 authored Jan 31, 2025
1 parent 6cc1bf1 commit 738836b
Show file tree
Hide file tree
Showing 14 changed files with 533 additions and 65 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/nugetTests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
- name: Install NuGet
uses: nuget/setup-nuget@v2
with:
nuget-version: '6.x'
nuget-version: '8.x'

- name: Setup Go with cache
uses: jfrog/.github/actions/install-go-with-cache@main
Expand Down
2 changes: 1 addition & 1 deletion artifactory/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -1871,7 +1871,7 @@ func buildScanLegacyCmd(c *cli.Context) error {

func checkBuildScanError(err error) error {
// If the build was found vulnerable, exit with ExitCodeVulnerableBuild.
if err == utils.GetBuildScanError() {
if errors.Is(err, utils.GetBuildScanError()) {
return coreutils.CliError{ExitCode: coreutils.ExitCodeVulnerableBuild, ErrorMsg: err.Error()}
}
// If the scan operation failed, for example due to HTTP timeout, exit with ExitCodeError.
Expand Down
73 changes: 72 additions & 1 deletion buildtools/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import (
"errors"
"fmt"
"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/python"
"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/setup"
"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
"github.com/jfrog/jfrog-cli-core/v2/utils/ioutils"
"github.com/jfrog/jfrog-cli-security/utils/techutils"
setupdocs "github.com/jfrog/jfrog-cli/docs/buildtools/setup"
"os"
"strconv"
"strings"
Expand Down Expand Up @@ -65,11 +69,21 @@ import (
)

const (
buildToolsCategory = "Build Tools"
buildToolsCategory = "Package Managers:"
)

func GetCommands() []cli.Command {
return cliutils.GetSortedCommands(cli.CommandsByName{
{
Name: "setup",
Flags: cliutils.GetCommandFlags(cliutils.Setup),
Usage: setupdocs.GetDescription(),
HelpName: corecommon.CreateUsage("setup", setupdocs.GetDescription(), setupdocs.Usage),
ArgsUsage: common.CreateEnvVars(),
UsageText: setupdocs.GetArguments(),
BashComplete: corecommon.CreateBashCompletionFunc(setup.GetSupportedPackageManagersList()...),
Action: setupCmd,
},
{
Name: "mvn-config",
Aliases: []string{"mvnc"},
Expand Down Expand Up @@ -929,6 +943,63 @@ func NpmPublishCmd(c *cli.Context) (err error) {
return
}

func setupCmd(c *cli.Context) (err error) {
if c.NArg() > 1 {
return cliutils.WrongNumberOfArgumentsHandler(c)
}
var packageManager project.ProjectType
packageManagerStr := c.Args().Get(0)
// If the package manager was provided as an argument, validate it.
if packageManagerStr != "" {
packageManager = project.FromString(packageManagerStr)
if !setup.IsSupportedPackageManager(packageManager) {
return cliutils.PrintHelpAndReturnError(fmt.Sprintf("The package manager %s is not supported", packageManagerStr), c)
}
} else {
// If the package manager wasn't provided as an argument, select it interactively.
packageManager, err = selectPackageManagerInteractively()
if err != nil {
return
}
}
setupCmd := setup.NewSetupCommand(packageManager)
artDetails, err := cliutils.CreateArtifactoryDetailsByFlags(c)
if err != nil {
return err
}
repoName := c.String("repo")
if repoName != "" {
// If a repository was provided, validate it exists in Artifactory.
if err = validateRepoExists(repoName, artDetails); err != nil {
return err
}
}
setupCmd.SetServerDetails(artDetails).SetRepoName(repoName).SetProjectKey(cliutils.GetProject(c))
return commands.Exec(setupCmd)
}

// validateRepoExists checks if the specified repository exists in Artifactory.
func validateRepoExists(repoName string, artDetails *coreConfig.ServerDetails) error {
serviceDetails, err := artDetails.CreateArtAuthConfig()
if err != nil {
return err
}
return utils.ValidateRepoExists(repoName, serviceDetails)
}

func selectPackageManagerInteractively() (selectedPackageManager project.ProjectType, err error) {
var selected string
var selectableItems []ioutils.PromptItem
for _, packageManager := range setup.GetSupportedPackageManagersList() {
selectableItems = append(selectableItems, ioutils.PromptItem{Option: packageManager, TargetValue: &selected})
}
err = ioutils.SelectString(selectableItems, "Please select a package manager to set up:", false, func(item ioutils.PromptItem) {
*item.TargetValue = item.Option
selectedPackageManager = project.FromString(*item.TargetValue)
})
return
}

func GetNpmConfigAndArgs(c *cli.Context) (configFilePath string, args []string, err error) {
configFilePath, err = getProjectConfigPathOrThrow(project.Npm, "npm", "npm-config")
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion buildtools/help.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ package buildtools

import (
corecommon "github.com/jfrog/jfrog-cli-core/v2/docs/common"
"github.com/jfrog/jfrog-cli/docs/artifactory/npmpublish"
"github.com/jfrog/jfrog-cli/docs/buildtools/dockerpull"
"github.com/jfrog/jfrog-cli/docs/buildtools/dockerpush"
"github.com/jfrog/jfrog-cli/docs/buildtools/npmci"
"github.com/jfrog/jfrog-cli/docs/buildtools/npminstall"
"github.com/jfrog/jfrog-cli/docs/buildtools/npmpublish"
"github.com/jfrog/jfrog-cli/docs/common"
"github.com/jfrog/jfrog-cli/utils/cliutils"
"github.com/urfave/cli"
Expand Down
18 changes: 18 additions & 0 deletions docs/buildtools/setup/help.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package setup

import (
"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/setup"
"strings"
)

var Usage = []string{"setup [command options]",
"setup <package manager> [command options]"}

func GetDescription() string {
return "An interactive command to configure your local package manager (e.g., npm, pip) to work with JFrog Artifactory."
}

func GetArguments() string {
return ` package manager
The package manager to configure. Supported package managers are: ` + strings.Join(setup.GetSupportedPackageManagersList(), ", ") + "."
}
47 changes: 30 additions & 17 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ replace (
)

require (
github.com/agnivade/levenshtein v1.2.0
github.com/agnivade/levenshtein v1.2.1
github.com/buger/jsonparser v1.1.1
github.com/docker/docker v27.3.1+incompatible
github.com/docker/docker v27.5.1+incompatible
github.com/gocarina/gocsv v0.0.0-20240520201108-78e41c74b4b1
github.com/jfrog/archiver/v3 v3.6.1
github.com/jfrog/build-info-go v1.10.8
Expand All @@ -26,7 +26,7 @@ require (
github.com/jszwec/csvutil v1.10.0
github.com/manifoldco/promptui v0.9.0
github.com/stretchr/testify v1.10.0
github.com/testcontainers/testcontainers-go v0.34.0
github.com/testcontainers/testcontainers-go v0.35.0
github.com/urfave/cli v1.22.16
github.com/xeipuuv/gojsonschema v1.2.0
golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c
Expand All @@ -44,6 +44,7 @@ require (
github.com/VividCortex/ewma v1.2.0 // indirect
github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect
github.com/andybalholm/brotli v1.1.0 // indirect
github.com/apache/camel-k/v2 v2.5.0 // indirect
github.com/beevik/etree v1.4.0 // indirect
github.com/c-bata/go-prompt v0.2.6 // indirect
github.com/cenkalti/backoff/v4 v4.3.0 // indirect
Expand All @@ -69,24 +70,28 @@ require (
github.com/go-git/go-git/v5 v5.13.0 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-logr/zapr v1.3.0 // indirect
github.com/go-ole/go-ole v1.2.6 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang-jwt/jwt/v4 v4.5.1 // indirect
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
github.com/golang/snappy v0.0.4 // indirect
github.com/google/go-github/v56 v56.0.0 // indirect
github.com/google/go-querystring v1.1.0 // indirect
github.com/google/gofuzz v1.2.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/gookit/color v1.5.4 // indirect
github.com/grokify/mogo v0.64.12 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/imdario/mergo v0.3.16 // indirect
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
github.com/jedib0t/go-pretty/v6 v6.6.5 // indirect
github.com/jfrog/froggit-go v1.16.2 // indirect
github.com/jfrog/go-mockhttp v0.3.1 // indirect
github.com/jfrog/jfrog-apps-config v1.0.1 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/kevinburke/ssh_config v1.2.0 // indirect
github.com/klauspost/compress v1.17.9 // indirect
github.com/klauspost/cpuid/v2 v2.2.7 // indirect
Expand All @@ -107,6 +112,8 @@ require (
github.com/moby/sys/user v0.1.0 // indirect
github.com/moby/sys/userns v0.1.0 // indirect
github.com/moby/term v0.5.0 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/morikuni/aec v1.0.0 // indirect
github.com/nwaples/rardecode v1.1.3 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
Expand Down Expand Up @@ -136,6 +143,7 @@ require (
github.com/spf13/cast v1.6.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/spf13/viper v1.19.0 // indirect
github.com/stoewer/go-strcase v1.3.0 // indirect
github.com/subosito/gotenv v1.6.0 // indirect
github.com/tklauser/go-sysconf v0.3.12 // indirect
github.com/tklauser/numcpus v0.6.1 // indirect
Expand All @@ -149,41 +157,46 @@ require (
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
github.com/yusufpapurcu/wmi v1.2.3 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
go.opentelemetry.io/otel v1.31.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.31.0 // indirect
go.opentelemetry.io/otel/metric v1.31.0 // indirect
go.opentelemetry.io/otel/sdk v1.31.0 // indirect
go.opentelemetry.io/otel/trace v1.31.0 // indirect
go.opentelemetry.io/otel v1.34.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.34.0 // indirect
go.opentelemetry.io/otel/metric v1.34.0 // indirect
go.opentelemetry.io/otel/sdk v1.34.0 // indirect
go.opentelemetry.io/otel/trace v1.34.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/crypto v0.32.0 // indirect
golang.org/x/mod v0.22.0 // indirect
golang.org/x/net v0.34.0 // indirect
golang.org/x/oauth2 v0.20.0 // indirect
golang.org/x/oauth2 v0.23.0 // indirect
golang.org/x/sync v0.10.0 // indirect
golang.org/x/sys v0.29.0 // indirect
golang.org/x/term v0.28.0 // indirect
golang.org/x/text v0.21.0 // indirect
golang.org/x/time v0.5.0 // indirect
golang.org/x/time v0.7.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/warnings.v0 v0.1.2 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/api v0.29.7 // indirect
k8s.io/apimachinery v0.29.7 // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/utils v0.0.0-20240310230437-4693a0247e57 // indirect
sigs.k8s.io/controller-runtime v0.17.5 // indirect
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
)

replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20250130104846-27e495de291e

replace github.com/jfrog/jfrog-cli-artifactory => github.com/jfrog/jfrog-cli-artifactory v0.1.12-0.20250128042424-bb6a289e237c
replace github.com/jfrog/jfrog-cli-artifactory => github.com/jfrog/jfrog-cli-artifactory v0.1.12-0.20250130144915-01446cff31ac

replace github.com/jfrog/jfrog-cli-security => github.com/jfrog/jfrog-cli-security v1.14.2-0.20250130082759-0d5b0bef7b8e

// replace github.com/jfrog/jfrog-cli-security => github.com/EyalDelarea/jfrog-cli-security v0.0.0-20241121103043-02719f295f02

replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20250126110945-81abbdde452f

// replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20241220065541-91828d43d8b9

// replace github.com/jfrog/gofrog => github.com/jfrog/gofrog dev

// replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20250101110857-b26e9a6644c6

// replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20250112155823-f3d607f5d854
Loading

0 comments on commit 738836b

Please sign in to comment.