| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 1 | // Copyright 2016 The Go Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style |
| 3 | // license that can be found in the LICENSE file. |
| 4 | |
| 5 | package dep |
| 6 | |
| 7 | import ( |
| 8 | "fmt" |
| 9 | "os" |
| 10 | "path/filepath" |
| 11 | |
| Ibrahim AshShohail | 68475b7 | 2017-05-13 01:05:35 | [diff] [blame] | 12 | "github.com/golang/dep/internal/fs" |
| Dave Cheney | 9ea8489 | 2017-05-10 04:13:22 | [diff] [blame] | 13 | "github.com/golang/dep/internal/gps" |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 14 | ) |
| 15 | |
| 16 | var errProjectNotFound = fmt.Errorf("could not find project %s, use dep init to initiate a manifest", ManifestName) |
| Sunny | 47302cf | 2017-05-12 13:14:50 | [diff] [blame] | 17 | var errVendorBackupFailed = fmt.Errorf("Failed to create vendor backup. File with same name exists.") |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 18 | |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 19 | // findProjectRoot searches from the starting directory upwards looking for a |
| 20 | // manifest file until we get to the root of the filesystem. |
| 21 | func findProjectRoot(from string) (string, error) { |
| 22 | for { |
| 23 | mp := filepath.Join(from, ManifestName) |
| 24 | |
| 25 | _, err := os.Stat(mp) |
| 26 | if err == nil { |
| 27 | return from, nil |
| 28 | } |
| 29 | if !os.IsNotExist(err) { |
| 30 | // Some err other than non-existence - return that out |
| 31 | return "", err |
| 32 | } |
| 33 | |
| 34 | parent := filepath.Dir(from) |
| 35 | if parent == from { |
| 36 | return "", errProjectNotFound |
| 37 | } |
| 38 | from = parent |
| 39 | } |
| 40 | } |
| 41 | |
| Jordan Krage | c2491a6 | 2017-05-31 19:48:48 | [diff] [blame] | 42 | // A Project holds a Manifest and optional Lock for a project. |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 43 | type Project struct { |
| 44 | // AbsRoot is the absolute path to the root directory of the project. |
| 45 | AbsRoot string |
| Ibrahim AshShohail | 71a2607 | 2017-06-14 22:30:25 | [diff] [blame] | 46 | // ResolvedAbsRoot is the resolved absolute path to the root directory of the project. |
| 47 | // If AbsRoot is not a symlink, then ResolvedAbsRoot should equal AbsRoot. |
| 48 | ResolvedAbsRoot string |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 49 | // ImportRoot is the import path of the project's root directory. |
| 50 | ImportRoot gps.ProjectRoot |
| 51 | Manifest *Manifest |
| Jordan Krage | c2491a6 | 2017-05-31 19:48:48 | [diff] [blame] | 52 | Lock *Lock // Optional |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 53 | } |
| 54 | |
| Ibrahim AshShohail | 3826bb0 | 2017-06-17 00:51:08 | [diff] [blame] | 55 | // SetRoot sets the project AbsRoot and ResolvedAbsRoot. If root is a not symlink, ResolvedAbsRoot will be set to root. |
| Ibrahim AshShohail | 9166034 | 2017-06-14 23:36:01 | [diff] [blame] | 56 | func (p *Project) SetRoot(root string) error { |
| Ibrahim AshShohail | 3826bb0 | 2017-06-17 00:51:08 | [diff] [blame] | 57 | rroot, err := filepath.EvalSymlinks(root) |
| Ibrahim AshShohail | b98d713 | 2017-06-16 18:25:58 | [diff] [blame] | 58 | if err != nil { |
| Ibrahim AshShohail | 9166034 | 2017-06-14 23:36:01 | [diff] [blame] | 59 | return err |
| Ibrahim AshShohail | b98d713 | 2017-06-16 18:25:58 | [diff] [blame] | 60 | } |
| 61 | |
| Ibrahim AshShohail | 3826bb0 | 2017-06-17 00:51:08 | [diff] [blame] | 62 | p.ResolvedAbsRoot, p.AbsRoot = rroot, root |
| Ibrahim AshShohail | 9166034 | 2017-06-14 23:36:01 | [diff] [blame] | 63 | return nil |
| Ibrahim AshShohail | 5bf9205 | 2017-06-13 12:50:12 | [diff] [blame] | 64 | } |
| 65 | |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 66 | // MakeParams is a simple helper to create a gps.SolveParameters without setting |
| 67 | // any nils incorrectly. |
| 68 | func (p *Project) MakeParams() gps.SolveParameters { |
| 69 | params := gps.SolveParameters{ |
| sam boyer | 8438fd4 | 2017-04-15 05:06:44 | [diff] [blame] | 70 | RootDir: p.AbsRoot, |
| sam boyer | 00a5b76 | 2017-04-15 05:23:16 | [diff] [blame] | 71 | ProjectAnalyzer: Analyzer{}, |
| Miguel Molina | 0acfd38 | 2017-01-27 20:39:07 | [diff] [blame] | 72 | } |
| 73 | |
| 74 | if p.Manifest != nil { |
| 75 | params.Manifest = p.Manifest |
| 76 | } |
| 77 | |
| 78 | if p.Lock != nil { |
| 79 | params.Lock = p.Lock |
| 80 | } |
| 81 | |
| 82 | return params |
| 83 | } |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 84 | |
| 85 | // BackupVendor looks for existing vendor directory and if it's not empty, |
| 86 | // creates a backup of it to a new directory with the provided suffix. |
| 87 | func BackupVendor(vpath, suffix string) (string, error) { |
| 88 | // Check if there's a non-empty vendor directory |
| Ibrahim AshShohail | 68475b7 | 2017-05-13 01:05:35 | [diff] [blame] | 89 | vendorExists, err := fs.IsNonEmptyDir(vpath) |
| mstrong | 7870384 | 2017-06-18 13:16:02 | [diff] [blame] | 90 | if err != nil && !os.IsNotExist(err) { |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 91 | return "", err |
| 92 | } |
| 93 | if vendorExists { |
| Jonathan Stacks | 98250d4 | 2017-05-20 15:22:09 | [diff] [blame] | 94 | // vpath is a full filepath. We need to split it to prefix the backup dir |
| 95 | // with an "_" |
| 96 | vpathDir, name := filepath.Split(vpath) |
| 97 | vendorbak := filepath.Join(vpathDir, "_"+name+"-"+suffix) |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 98 | // Check if a directory with same name exists |
| 99 | if _, err = os.Stat(vendorbak); os.IsNotExist(err) { |
| Sunny | 4470034 | 2017-06-01 10:22:29 | [diff] [blame] | 100 | // Copy existing vendor to vendor-{suffix} |
| 101 | if err := fs.CopyDir(vpath, vendorbak); err != nil { |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 102 | return "", err |
| 103 | } |
| 104 | return vendorbak, nil |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 105 | } |
| Sunny | 1709f38 | 2017-05-13 21:47:27 | [diff] [blame] | 106 | return "", errVendorBackupFailed |
| Sunny | 45162e5 | 2017-05-11 16:56:14 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | return "", nil |
| 110 | } |
