|
| 1 | +package builders |
| 2 | + |
| 3 | +import ( |
| 4 | + "errors" |
| 5 | + "fmt" |
| 6 | + "io/ioutil" |
| 7 | + "os" |
| 8 | + "path/filepath" |
| 9 | + "regexp" |
| 10 | + "strings" |
| 11 | + |
| 12 | + "github.com/bmatcuk/doublestar" |
| 13 | + logging "github.com/op/go-logging" |
| 14 | + |
| 15 | + "github.com/fossas/fossa-cli/module" |
| 16 | +) |
| 17 | + |
| 18 | +var nugetLogger = logging.MustGetLogger("nuget") |
| 19 | + |
| 20 | +// NuGetPackage implements Dependency for NuGet |
| 21 | +type NuGetPackage struct { |
| 22 | + Name string `json:"name"` |
| 23 | + Version string `json:"version"` |
| 24 | +} |
| 25 | + |
| 26 | +// Fetcher always returns gem for NuGetPackage |
| 27 | +func (m NuGetPackage) Fetcher() string { |
| 28 | + return "nuget" |
| 29 | +} |
| 30 | + |
| 31 | +// Package returns the package spec for NuGetPackage |
| 32 | +func (m NuGetPackage) Package() string { |
| 33 | + return m.Name |
| 34 | +} |
| 35 | + |
| 36 | +// Revision returns the version spec for NuGetPackage |
| 37 | +func (m NuGetPackage) Revision() string { |
| 38 | + return m.Version |
| 39 | +} |
| 40 | + |
| 41 | +type nuGetLockfileV2or3 struct { |
| 42 | + Libraries map[string]struct{} `json:"libraries"` |
| 43 | +} |
| 44 | + |
| 45 | +// NuGetBuilder implements Builder for Bundler (Gemfile) builds |
| 46 | +type NuGetBuilder struct { |
| 47 | + DotNETCmd string |
| 48 | + DotNETVersion string |
| 49 | + NuGetCmd string |
| 50 | + NuGetVersion string |
| 51 | +} |
| 52 | + |
| 53 | +// Initialize collects metadata on NuGet and .NET environments |
| 54 | +func (builder *NuGetBuilder) Initialize() error { |
| 55 | + nugetLogger.Debug("Initializing NuGet builder...") |
| 56 | + |
| 57 | + // Set DotNET context variables |
| 58 | + dotNetCmd, dotNetVersion, err := which("--version", os.Getenv("DOTNET_BINARY"), "dotnet") |
| 59 | + if err != nil { |
| 60 | + nugetLogger.Warningf("Could not find `dotnet` binary (try setting $DOTNET_BINARY): %s", err.Error()) |
| 61 | + } |
| 62 | + builder.DotNETCmd = dotNetCmd |
| 63 | + builder.DotNETVersion = strings.TrimRight(dotNetVersion, "\n") |
| 64 | + |
| 65 | + // Set NuGet context variables |
| 66 | + nuGetCmd, nuGetVersonOut, err := which("help", os.Getenv("NUGET_BINARY"), "nuget") |
| 67 | + if err == nil { |
| 68 | + builder.NuGetCmd = nuGetCmd |
| 69 | + |
| 70 | + nuGetVersionMatchRe := regexp.MustCompile(`NuGet Version: ([0-9]+\.[0-9]+\.[0-9]+.\w+)`) |
| 71 | + match := nuGetVersionMatchRe.FindStringSubmatch(nuGetVersonOut) |
| 72 | + if len(match) == 2 { |
| 73 | + builder.NuGetVersion = match[1] |
| 74 | + } |
| 75 | + } else { |
| 76 | + nugetLogger.Warningf("Could not find NuGet binary (try setting $NUGET_BINARY): %s", err.Error()) |
| 77 | + } |
| 78 | + |
| 79 | + nugetLogger.Debugf("Initialized NuGet builder: %#v", builder) |
| 80 | + return nil |
| 81 | +} |
| 82 | + |
| 83 | +// Build runs `dotnet restore` and falls back to `nuget restore` |
| 84 | +func (builder *NuGetBuilder) Build(m module.Module, force bool) error { |
| 85 | + nugetLogger.Debugf("Running NuGet build: %#v %#v", m, force) |
| 86 | + |
| 87 | + if builder.DotNETCmd != "" { |
| 88 | + dotNetSuccessKey := "Restore completed" |
| 89 | + dotNetStdout, dotNetStderr, err := runLogged(nugetLogger, m.Dir, builder.DotNETCmd, "restore") |
| 90 | + if err == nil && (strings.Contains(dotNetStdout, dotNetSuccessKey) || strings.Contains(dotNetStderr, dotNetSuccessKey)) { |
| 91 | + nugetLogger.Debug("NuGet build succeeded with `dotnet restore`.") |
| 92 | + return nil |
| 93 | + } |
| 94 | + } |
| 95 | + |
| 96 | + nugetLogger.Debug("`dotnet restore` did not succeed, falling back to `nuget restore`") |
| 97 | + |
| 98 | + if builder.NuGetCmd != "" { |
| 99 | + pkgDir, _ := resolveNugetPackagesDir(m.Dir) |
| 100 | + _, _, err := runLogged(nugetLogger, m.Dir, builder.NuGetCmd, "restore", "-PackagesDirectory", pkgDir) |
| 101 | + if err != nil { |
| 102 | + return fmt.Errorf("could not run `nuget install`: %s", err.Error()) |
| 103 | + } |
| 104 | + } else { |
| 105 | + return errors.New("No tools installed in local environment for NuGet build") |
| 106 | + } |
| 107 | + |
| 108 | + nugetLogger.Debug("Done running NuGet build.") |
| 109 | + return nil |
| 110 | +} |
| 111 | + |
| 112 | +// Analyze parses the output of NuGet lockfiles and falls back to parsing the packages folder |
| 113 | +func (builder *NuGetBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error) { |
| 114 | + nugetLogger.Debugf("Running NuGet analysis: %#v %#v", m, allowUnresolved) |
| 115 | + |
| 116 | + deps := []module.Dependency{} |
| 117 | + |
| 118 | + // Find and parse a lockfile |
| 119 | + lockFilePath, err := resolveNuGetProjectLockfile(m.Dir) |
| 120 | + if err == nil { |
| 121 | + var lockFile nuGetLockfileV2or3 |
| 122 | + if err := parseLogged(nugetLogger, lockFilePath, &lockFile); err == nil { |
| 123 | + for depKey := range lockFile.Libraries { |
| 124 | + depKeyParts := strings.Split(depKey, "/") |
| 125 | + if len(depKeyParts) == 2 { |
| 126 | + deps = append(deps, module.Dependency(NuGetPackage{ |
| 127 | + Name: depKeyParts[0], |
| 128 | + Version: depKeyParts[1], |
| 129 | + })) |
| 130 | + } |
| 131 | + } |
| 132 | + } |
| 133 | + } else { |
| 134 | + // Fallback to parsing the packages directory |
| 135 | + packagesDir, err := resolveNugetPackagesDir(m.Dir) |
| 136 | + |
| 137 | + nugetLogger.Debugf("No lockfile found; parsing packages directory: %s", packagesDir) |
| 138 | + if exists, err := hasFile(packagesDir); err != nil || !exists { |
| 139 | + return nil, fmt.Errorf("Unable to verify packages directory: %s", packagesDir) |
| 140 | + } |
| 141 | + |
| 142 | + packagePaths, err := ioutil.ReadDir(packagesDir) |
| 143 | + if err != nil { |
| 144 | + return nil, err |
| 145 | + } |
| 146 | + |
| 147 | + for _, f := range packagePaths { |
| 148 | + packageNameRe := regexp.MustCompile(`(([A-z]+\.?)+)\.(([0-9]+\.)+[\w-]+)`) |
| 149 | + match := packageNameRe.FindStringSubmatch(f.Name()) |
| 150 | + nugetLogger.Debugf("%s, %V", len(match), match) |
| 151 | + if len(match) == 5 { |
| 152 | + deps = append(deps, module.Dependency(NuGetPackage{ |
| 153 | + Name: match[1], |
| 154 | + Version: match[3], |
| 155 | + })) |
| 156 | + } |
| 157 | + } |
| 158 | + } |
| 159 | + |
| 160 | + // TODO: filter out system deps |
| 161 | + |
| 162 | + nugetLogger.Debugf("Done running NuGet analysis: %#v", deps) |
| 163 | + return deps, nil |
| 164 | +} |
| 165 | + |
| 166 | +// IsBuilt checks the existance of a lockfile or a packages directory |
| 167 | +func (builder *NuGetBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error) { |
| 168 | + if allowUnresolved { |
| 169 | + return true, nil |
| 170 | + } |
| 171 | + |
| 172 | + nugetLogger.Debug("Checking NuGet module directory for a project lockfile") |
| 173 | + if _, err := resolveNuGetProjectLockfile(m.Dir); err != nil { |
| 174 | + nugetLogger.Debug("Checking NuGet packages directory for existence") |
| 175 | + |
| 176 | + packagesDir, _ := resolveNugetPackagesDir(m.Dir) |
| 177 | + return hasFile(packagesDir) |
| 178 | + } |
| 179 | + |
| 180 | + return true, nil |
| 181 | +} |
| 182 | + |
| 183 | +// IsModule is not implemented |
| 184 | +func (builder *NuGetBuilder) IsModule(target string) (bool, error) { |
| 185 | + return false, errors.New("IsModule is not implemented for NuGetBuilder") |
| 186 | +} |
| 187 | + |
| 188 | +// resolveNugetPackagesDir parses a NuGet module config and resolves it to an existing package directory |
| 189 | +func resolveNugetPackagesDir(dir string) (string, error) { |
| 190 | + packagesDir := filepath.Join(dir, "packages") |
| 191 | + return packagesDir, fmt.Errorf("unable to resolve NuGet packages directory: %s", "Not Implemented.") |
| 192 | +} |
| 193 | + |
| 194 | +func resolveNuGetProjectLockfile(dir string) (string, error) { |
| 195 | + lockfilePathCandidates := []string{"project.lock.json", "obj/project.assets.json"} |
| 196 | + for _, path := range lockfilePathCandidates { |
| 197 | + nugetLogger.Debugf("Checking for lockfile: %s/%s", dir, path) |
| 198 | + if hasLockfile, err := hasFile(dir, path); hasLockfile && err == nil { |
| 199 | + return filepath.Join(dir, path), nil |
| 200 | + } |
| 201 | + } |
| 202 | + |
| 203 | + return "", fmt.Errorf("No lockfiles detected in directory root: %s", dir) |
| 204 | +} |
| 205 | + |
| 206 | +// DiscoverModules returns ModuleConfigs that match `packages.config` in the directory |
| 207 | +func (builder *NuGetBuilder) DiscoverModules(dir string) ([]module.Config, error) { |
| 208 | + packageRecordPaths, err := doublestar.Glob(filepath.Join(dir, "**", "{*.csproj,*.xproj,*.vbproj,*.dbproj,*.fsproj,packages.config,project.json,*.nuspec}")) |
| 209 | + if err != nil { |
| 210 | + return nil, err |
| 211 | + } |
| 212 | + moduleConfigs := make([]module.Config, 0) |
| 213 | + for _, path := range packageRecordPaths { |
| 214 | + packageName := filepath.Base(filepath.Dir(path)) |
| 215 | + // infer title from *.nuspec in directory if exists |
| 216 | + nuSpecs, err := doublestar.Glob(filepath.Join(filepath.Dir(path), "*.nuspec")) |
| 217 | + if err == nil && len(nuSpecs) > 0 { |
| 218 | + packageName = strings.TrimRight(filepath.Base(nuSpecs[0]), ".nuspec") |
| 219 | + } |
| 220 | + path, _ := filepath.Rel(dir, path) |
| 221 | + packagePath := filepath.Dir(path) |
| 222 | + |
| 223 | + seen := false |
| 224 | + for _, m := range moduleConfigs { |
| 225 | + if m.Name == packageName && m.Path == packagePath { |
| 226 | + seen = true |
| 227 | + break |
| 228 | + } |
| 229 | + } |
| 230 | + if !seen { |
| 231 | + moduleConfigs = append(moduleConfigs, module.Config{ |
| 232 | + Name: packageName, |
| 233 | + Path: packagePath, |
| 234 | + Type: "nuget", |
| 235 | + }) |
| 236 | + } |
| 237 | + } |
| 238 | + |
| 239 | + return moduleConfigs, nil |
| 240 | +} |
0 commit comments