add Gomfile importer #746

mattn · 2017-06-13T01:44:49Z

Adds Gomfile importer support to init.

TODO

* add detection for production/test environments

carolynvs · 2017-06-13T17:43:44Z

cmd/dep/gom_importer.go

+			lp := gps.NewLockedProject(pi, version, nil)
+			lock.P = append(lock.P, lp)
+		}
+		manifest.Constraints[pc.Ident.ProjectRoot] = gps.ProjectProperties{Source: pc.Ident.Source, Constraint: nil}


Did you intend to always leave the constraint in the manifest nil? When the gomfile specifies :tag => '1.0.0', or :branch => 'master' for example, both are valid constraints that can be figured out using deduceConstraint.

mattn · 2017-06-14T04:27:14Z

I consider about production/develop environments for gom. But maybe, all of packages writen in Gomfile should be exported in Gopkg.toml. So I'll remove [WIP] and [DO NOT MERGE].

carolynvs

Thanks for adding support for gom! Really excited to get this incorporated. 🎉

carolynvs · 2017-06-16T23:13:53Z

cmd/dep/gom_importer.go

+	lock := &dep.Lock{}
+
+	for _, pkg := range g.goms {
+		// Obtain ProjectRoot. Required for avoiding sub-package imports.


Is it valid config to specify a sub-package? For example:

Gomfile

gom 'github.com/davecgh/go-spew/spew', :tag => 'v1.1.0'

If not, then you can remove the logic that detects the project root and check if the project exists in the lock.

Sorry, I don't clearly understand what you mean. Yes, it's valid entry in Gomfile.

carolynvs · 2017-06-16T23:18:55Z

cmd/dep/gom_importer.go

+				g.logger.Printf(warn.Error())
+				version = revision
+			}
+			feedback(version, pi.ProjectRoot, fb.DepTypeImported, g.logger)


You'll need to rebase to get the latest changes to the feedback function. It has been deprecated. Here's an example of the updated feedback usage.

It is new separate calls for logging feedback for a constraint and a locked project, so you'll need to add more feedback after setting the constraint in the manifest.

carolynvs · 2017-06-16T23:21:07Z

cmd/dep/gom_importer_test.go

+	}
+}
+
+func TestGomConfig_ProjectExistsInLock(t *testing.T) {


This is a duplicate test of

dep/cmd/dep/godep_importer_test.go

Line 305 in cc11274

func TestGodepConfig_ProjectExistsInLock(t *testing.T) {

and can be removed.

carolynvs · 2017-06-16T23:21:46Z

cmd/dep/gom_importer_test.go

+}
+
+// Compares two slices of gomPackage and checks if they are equal.
+func equalGomImports(a, b []gomPackage) bool {


This looks like it's unused?

carolynvs · 2017-06-16T23:29:58Z

cmd/dep/testdata/gom/Gomfile

@@ -0,0 +1,2 @@
+gom "github.com/sdboyer/deptest", :commit => "3f4c3bea144e112a69bbe5d8d01c1b09a544253f"


I notice that this only has testdata for :commit and not :tag or :branch. Since we also need an integration test for dep init importing a gomfile, see godep for an integration test example, you could include those in that new integration test.

It is important that tests for :branch and :tag are added, in addition to an integration test.

sdboyer · 2017-07-21T23:43:19Z

bump

carolynvs · 2017-07-25T23:12:10Z

cmd/dep/gom_importer.go

+			revision := gps.Revision(rev)
+			version, err := lookupVersionForLockedProject(pi, pc.Constraint, revision, g.sm)
+			if err != nil {
+				warn := errors.Wrapf(err, "Unable to lookup the version represented by %s in %s. Falling back to locking the revision only.", rev, pi.ProjectRoot)


The warning message, and falling back to the revision is now handled in lookupVersionForLockedProject, so you can just print the err if it's present, and remove the version = revision assignment.

See the godep importer for an example.

carolynvs · 2017-07-25T23:17:14Z

cmd/dep/testdata/gom/expected_import_output.txt

@@ -0,0 +1,4 @@
+Detected Gomfile...
+Converting from Gomfile ...
+  Trying v0.8.1 (3f4c3be) as initial lock for imported dep github.com/sdboyer/deptest


There should be 2 extra lines in the output, looks like it is missing the constraints and is only printing the locked projects.

carolynvs · 2017-07-25T23:18:39Z

cmd/dep/gom_importer.go

+		pc.Ident = pi
+
+		if rev != "" {
+			pc.Constraint, err = g.sm.InferConstraint(rev, pc.Ident)


When revision == "", you should set the constraint to gps.Any().

Ah, I didn't know gps.Any(). Okay, will do it in later.

After thinking about this more, I think the right answer is to do that in InferConstraint, so that when an empty string is passed, it returns gps.Any(). I'll submit a PR for that in a bit.

I've submitted #901 so that all importers get this for free when calling InferConstraint.

carolynvs · 2017-07-25T23:34:10Z

cmd/dep/gom_importer.go

+				return nil, nil, err
+			}
+
+			revision := gps.Revision(rev)


I am not sure what you are doing on this line? This won't be valid when rev is a branch or a tag.

I noticed that you first try to load a gomfile.lock and fallback to a gomfile. Does the gomfile.lock contain just :commit entries and the gomefile contain entries for :branch and :tag? With other dependency managers, like glide, there are two files and we use both. One to import constraints and the other to know which revision to put in the lock.

At a high level what needs to happen here is this:

If a constraint such as a branch or tag is available, it should be used as the constraint in the manifest. Otherwise, use gps.Any(). We don't want to put a revision/commit in the constraint.

Log the constraint using f := fb.NewConstraintFeedback(pc, fb.DepTypeImported).LogFeedback(g.logger).

Call lookupVersionForLockedProject passing in the project, the constraint from the first step and the revision (:commit) from the lock.

Make a locked project and log it.

carolynvs · 2017-07-25T23:37:59Z

cmd/dep/testdata/gom/Gomfile

@@ -0,0 +1,2 @@
+gom "github.com/sdboyer/deptest", :commit => "3f4c3bea144e112a69bbe5d8d01c1b09a544253f"


It is important that tests for :branch and :tag are added, in addition to an integration test.

mvdan · 2020-09-04T15:10:27Z

Dep was officially deprecated earlier this year, and the proposal to archive this repository was accepted. As such, I'm closing outstanding issues before archiving the repository. For any further comments, please use the proposal thread on the Go issue tracker. Thanks!

googlebot added the cla: yes label Jun 13, 2017

mattn force-pushed the gom-importer branch from 572af7c to 41445d7 Compare June 13, 2017 02:01

mattn changed the title ~~[WIP] add Gomfile importer~~ [WIP][DO NOT MERGE] add Gomfile importer Jun 13, 2017

sdboyer added the area: init label Jun 13, 2017

carolynvs self-requested a review June 13, 2017 17:23

carolynvs reviewed Jun 13, 2017

View reviewed changes

mattn changed the title ~~[WIP][DO NOT MERGE] add Gomfile importer~~ add Gomfile importer Jun 14, 2017

carolynvs suggested changes Jun 16, 2017

View reviewed changes

carolynvs mentioned this pull request Jun 23, 2017

Alternate init modes #186

Closed

mattn added 9 commits July 22, 2017 15:11

add Gomfile importer

f7cf481

fix check err

a552c03

unreachable code

e6045bb

fix underscores

23ee21a

fix constraint

ae02dbb

gom doesn't support constant

c807efe

enable constraint

cb2d63d

rebase master

66a8d6e

remove test and staff

92dca1a

mattn force-pushed the gom-importer branch from f31346a to 92dca1a Compare July 22, 2017 06:23

mattn requested a review from sdboyer as a code owner July 22, 2017 06:23

fix build

06d2055

carolynvs suggested changes Jul 25, 2017

View reviewed changes

carolynvs mentioned this pull request Aug 30, 2017

Standardize the importers #1100

Merged

mvdan closed this Sep 4, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add Gomfile importer #746

add Gomfile importer #746

mattn commented Jun 13, 2017 •

edited

Loading

carolynvs Jun 13, 2017

mattn commented Jun 14, 2017

carolynvs left a comment

carolynvs Jun 16, 2017

mattn Jul 22, 2017

carolynvs Jun 16, 2017

carolynvs Jun 16, 2017

carolynvs Jun 16, 2017

carolynvs Jun 16, 2017

carolynvs Jul 25, 2017

sdboyer commented Jul 21, 2017

carolynvs Jul 25, 2017

carolynvs Jul 25, 2017

carolynvs Jul 25, 2017

mattn Jul 25, 2017

carolynvs Jul 26, 2017 •

edited

Loading

carolynvs Jul 26, 2017

carolynvs Jul 25, 2017

carolynvs Jul 25, 2017

mvdan commented Sep 4, 2020

		@@ -0,0 +1,2 @@
		gom "github.com/sdboyer/deptest", :commit => "3f4c3bea144e112a69bbe5d8d01c1b09a544253f"

add Gomfile importer #746

add Gomfile importer #746

Conversation

mattn commented Jun 13, 2017 • edited Loading

TODO

Choose a reason for hiding this comment

mattn commented Jun 14, 2017

carolynvs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdboyer commented Jul 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carolynvs Jul 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mvdan commented Sep 4, 2020

mattn commented Jun 13, 2017 •

edited

Loading

carolynvs Jul 26, 2017 •

edited

Loading