|
| 1 | +package resolve |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "fmt" |
| 7 | + "os" |
| 8 | + |
| 9 | + "github.com/git-pkgs/managers" |
| 10 | + "github.com/git-pkgs/managers/definitions" |
| 11 | +) |
| 12 | + |
| 13 | +// InputDep describes a dependency to add to the generated project. |
| 14 | +type InputDep struct { |
| 15 | + Name string // package name in ecosystem-native format |
| 16 | + Version string // version constraint (optional) |
| 17 | +} |
| 18 | + |
| 19 | +// ErrInitNotSupported is returned when the manager does not support the init operation. |
| 20 | +var ErrInitNotSupported = errors.New("manager does not support init") |
| 21 | + |
| 22 | +// ErrResolveNotSupported is returned when the manager does not support the resolve operation. |
| 23 | +var ErrResolveNotSupported = errors.New("manager does not support resolve") |
| 24 | + |
| 25 | +// Managers returns the list of manager names that have registered parsers. |
| 26 | +func Managers() []string { |
| 27 | + names := make([]string, 0, len(parsers)) |
| 28 | + for name := range parsers { |
| 29 | + names = append(names, name) |
| 30 | + } |
| 31 | + return names |
| 32 | +} |
| 33 | + |
| 34 | +// EcosystemForManager returns the ecosystem name for a registered manager. |
| 35 | +func EcosystemForManager(manager string) (string, bool) { |
| 36 | + eco, ok := managerEcosystem[manager] |
| 37 | + return eco, ok |
| 38 | +} |
| 39 | + |
| 40 | +// ResolveDeps creates a temporary project, adds the given dependencies using the |
| 41 | +// specified package manager, runs resolution, and parses the output into a |
| 42 | +// dependency graph. |
| 43 | +// |
| 44 | +// The package manager CLI must be installed and available on PATH. |
| 45 | +func ResolveDeps(ctx context.Context, manager string, deps []InputDep) (*Result, error) { |
| 46 | + // Verify we have a parser for this manager. |
| 47 | + if _, ok := parsers[manager]; !ok { |
| 48 | + return nil, fmt.Errorf("%w: %s", ErrUnsupportedManager, manager) |
| 49 | + } |
| 50 | + |
| 51 | + // Clear environment variables that might leak from parent processes |
| 52 | + // (e.g. BUNDLE_GEMFILE from a Rails app calling this binary). |
| 53 | + clearParentEnv() |
| 54 | + |
| 55 | + // Create temp directory for the project. |
| 56 | + tmpDir, err := os.MkdirTemp("", "resolve-*") |
| 57 | + if err != nil { |
| 58 | + return nil, fmt.Errorf("creating temp dir: %w", err) |
| 59 | + } |
| 60 | + defer os.RemoveAll(tmpDir) |
| 61 | + |
| 62 | + // Set up the managers library. |
| 63 | + defs, err := definitions.LoadEmbedded() |
| 64 | + if err != nil { |
| 65 | + return nil, fmt.Errorf("loading manager definitions: %w", err) |
| 66 | + } |
| 67 | + |
| 68 | + translator := managers.NewTranslator() |
| 69 | + runner := managers.NewExecRunner() |
| 70 | + detector := managers.NewDetector(translator, runner) |
| 71 | + for _, def := range defs { |
| 72 | + detector.Register(def) |
| 73 | + } |
| 74 | + |
| 75 | + mgr, err := detector.Detect(tmpDir, managers.DetectOptions{Manager: manager}) |
| 76 | + if err != nil { |
| 77 | + return nil, fmt.Errorf("setting up manager %s: %w", manager, err) |
| 78 | + } |
| 79 | + |
| 80 | + // Init the project. |
| 81 | + if !mgr.Supports(managers.CapInit) { |
| 82 | + return nil, fmt.Errorf("%w: %s", ErrInitNotSupported, manager) |
| 83 | + } |
| 84 | + |
| 85 | + result, err := mgr.Init(ctx) |
| 86 | + if err != nil { |
| 87 | + return nil, fmt.Errorf("init %s: %w", manager, err) |
| 88 | + } |
| 89 | + if !result.Success() { |
| 90 | + return nil, fmt.Errorf("init %s: exit %d: %s", manager, result.ExitCode, result.Stderr) |
| 91 | + } |
| 92 | + |
| 93 | + // Some init commands create a subdirectory (mix new, lein new, etc.). |
| 94 | + // Re-detect from the same dir; the init should have created the manifest. |
| 95 | + mgr, err = detector.Detect(tmpDir, managers.DetectOptions{Manager: manager}) |
| 96 | + if err != nil { |
| 97 | + return nil, fmt.Errorf("re-detecting manager after init: %w", err) |
| 98 | + } |
| 99 | + |
| 100 | + // Add each dependency, skipping duplicates. |
| 101 | + if mgr.Supports(managers.CapAdd) { |
| 102 | + seen := make(map[string]bool) |
| 103 | + for _, dep := range deps { |
| 104 | + if seen[dep.Name] { |
| 105 | + continue |
| 106 | + } |
| 107 | + seen[dep.Name] = true |
| 108 | + |
| 109 | + opts := managers.AddOptions{ |
| 110 | + Version: dep.Version, |
| 111 | + } |
| 112 | + |
| 113 | + result, err := mgr.Add(ctx, dep.Name, opts) |
| 114 | + if err != nil { |
| 115 | + return nil, fmt.Errorf("add %s: %w", dep.Name, err) |
| 116 | + } |
| 117 | + if !result.Success() { |
| 118 | + return nil, fmt.Errorf("add %s: exit %d: %s", dep.Name, result.ExitCode, result.Stderr) |
| 119 | + } |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + // Run resolve to get the dependency graph output. |
| 124 | + if !mgr.Supports(managers.CapResolve) { |
| 125 | + return nil, fmt.Errorf("%w: %s", ErrResolveNotSupported, manager) |
| 126 | + } |
| 127 | + |
| 128 | + resolveResult, err := mgr.Resolve(ctx) |
| 129 | + if err != nil { |
| 130 | + return nil, fmt.Errorf("resolve %s: %w", manager, err) |
| 131 | + } |
| 132 | + |
| 133 | + // Parse the output. |
| 134 | + return Parse(manager, []byte(resolveResult.Stdout)) |
| 135 | +} |
| 136 | + |
| 137 | +// envVarsToClear lists specific environment variables that point to a parent |
| 138 | +// project and would cause package manager commands to operate on the wrong |
| 139 | +// directory (e.g. BUNDLE_GEMFILE from a Rails app). |
| 140 | +var envVarsToClear = []string{ |
| 141 | + "BUNDLE_GEMFILE", |
| 142 | + "BUNDLE_LOCKFILE", |
| 143 | + "BUNDLE_BIN_PATH", |
| 144 | + "BUNDLE_PATH", |
| 145 | + "BUNDLER_SETUP", |
| 146 | + "BUNDLER_VERSION", |
| 147 | + "GEM_HOME", |
| 148 | + "GEM_PATH", |
| 149 | + "RUBYOPT", |
| 150 | + "RUBYLIB", |
| 151 | +} |
| 152 | + |
| 153 | +// clearParentEnv removes environment variables that could interfere with |
| 154 | +// package manager commands run in a temporary directory. |
| 155 | +func clearParentEnv() { |
| 156 | + for _, key := range envVarsToClear { |
| 157 | + os.Unsetenv(key) |
| 158 | + } |
| 159 | +} |
0 commit comments