forked from golang/dep
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request golang#512 from darkowlzz/503-itemize-init-feedback
Add itemized feedback for dep resolution in init
- Loading branch information
Showing
3 changed files
with
172 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright 2017 The Go Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package feedback | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/golang/dep" | ||
| ) | ||
|
|
||
| // Constraint types | ||
| const ConsTypeConstraint = "constraint" | ||
| const ConsTypeHint = "hint" | ||
|
|
||
| // Dependency types | ||
| const DepTypeDirect = "direct dep" | ||
| const DepTypeTransitive = "transitive dep" | ||
|
|
||
| // ConstraintFeedback holds project constraint feedback data | ||
| type ConstraintFeedback struct { | ||
| Version, LockedVersion, Revision, ConstraintType, DependencyType, ProjectPath string | ||
| } | ||
|
|
||
| // LogFeedback logs the feedback | ||
| func (cf ConstraintFeedback) LogFeedback(ctx *dep.Ctx) { | ||
| // "Using" feedback for direct dep | ||
| if cf.DependencyType == DepTypeDirect { | ||
| ver := cf.Version | ||
| // revision as version for hint | ||
| if cf.ConstraintType == ConsTypeHint { | ||
| ver = cf.Revision | ||
| } | ||
| ctx.Loggers.Err.Printf(" %v", GetUsingFeedback(ver, cf.ConstraintType, cf.DependencyType, cf.ProjectPath)) | ||
| } | ||
| // No "Locking" feedback for hints. "Locking" feedback only for constraint | ||
| // and transitive dep | ||
| if cf.ConstraintType != ConsTypeHint { | ||
| ctx.Loggers.Err.Printf(" %v", GetLockingFeedback(cf.LockedVersion, cf.Revision, cf.DependencyType, cf.ProjectPath)) | ||
| } | ||
| } | ||
|
|
||
| // GetUsingFeedback returns dependency using feedback string. | ||
| // Example: | ||
| // Using ^1.0.0 as constraint for direct dep github.com/foo/bar | ||
| // Using 1b8edb3 as hint for direct dep github.com/bar/baz | ||
| func GetUsingFeedback(version, consType, depType, projectPath string) string { | ||
| return fmt.Sprintf("Using %s as %s for %s %s", version, consType, depType, projectPath) | ||
| } | ||
|
|
||
| // GetLockingFeedback returns dependency locking feedback string. | ||
| // Example: | ||
| // Locking in v1.1.4 (bc29b4f) for direct dep github.com/foo/bar | ||
| // Locking in master (436f39d) for transitive dep github.com/baz/qux | ||
| func GetLockingFeedback(version, revision, depType, projectPath string) string { | ||
| return fmt.Sprintf("Locking in %s (%s) for %s %s", version, revision, depType, projectPath) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Copyright 2017 The Go Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package feedback | ||
|
|
||
| import ( | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestGetConstraintString(t *testing.T) { | ||
| cases := []struct { | ||
| feedback string | ||
| want string | ||
| }{ | ||
| { | ||
| feedback: GetUsingFeedback("^1.0.0", ConsTypeConstraint, DepTypeDirect, "github.com/foo/bar"), | ||
| want: "Using ^1.0.0 as constraint for direct dep github.com/foo/bar", | ||
| }, | ||
| { | ||
| feedback: GetUsingFeedback("1b8edb3", ConsTypeHint, DepTypeDirect, "github.com/bar/baz"), | ||
| want: "Using 1b8edb3 as hint for direct dep github.com/bar/baz", | ||
| }, | ||
| { | ||
| feedback: GetLockingFeedback("v1.1.4", "bc29b4f", DepTypeDirect, "github.com/foo/bar"), | ||
| want: "Locking in v1.1.4 (bc29b4f) for direct dep github.com/foo/bar", | ||
| }, | ||
| { | ||
| feedback: GetLockingFeedback("master", "436f39d", DepTypeTransitive, "github.com/baz/qux"), | ||
| want: "Locking in master (436f39d) for transitive dep github.com/baz/qux", | ||
| }, | ||
| } | ||
|
|
||
| for _, c := range cases { | ||
| if c.want != c.feedback { | ||
| t.Fatalf("Feedbacks are not expected: \n\t(GOT) %v\n\t(WNT) %v", c.feedback, c.want) | ||
| } | ||
| } | ||
| } |