Merge pull request #1422 from s111/glock-importer

Add importer for github.com/robfig/glock

Author: carolynvs

CHANGELOG.md

@@ -1,6 +1,7 @@
 # v0.3.3 (Unreleased)
 
 NEW FEATURES:
+* Add support for importing from [glock](https://github.com/robfig/glock) based projects (#1422).
 * Add support for importing from [govendor](https://github.com/kardianos/govendor)
   based projects (#815).
 

cmd/dep/doc.go

@@ -38,7 +38,7 @@
 // When configuration for another dependency management tool is detected, it is
 // imported into the initial manifest and lock. Use the -skip-tools flag to
 // disable this behavior. The following external tools are supported:
-// glide, godep, vndr, govend, gb, gvt.
+// glide, godep, vndr, govend, gb, gvt, glock.
 //
 // Any dependencies that are not constrained by external configuration use the
 // GOPATH analysis below.

cmd/dep/init.go

@@ -30,7 +30,7 @@ specified, use the current directory.
 When configuration for another dependency management tool is detected, it is
 imported into the initial manifest and lock. Use the -skip-tools flag to
 disable this behavior. The following external tools are supported:
-glide, godep, vndr, govend, gb, gvt, govendor.
+glide, godep, vndr, govend, gb, gvt, govendor, glock.
 
 Any dependencies that are not constrained by external configuration use the
 GOPATH analysis below.

cmd/dep/testdata/harness_tests/init/glock/case1/final/Gopkg.lock

@@ -0,0 +1,4 @@
+
+[[constraint]]
+  name = "github.com/sdboyer/deptestdos"
+  version = "2.0.0"

cmd/dep/testdata/harness_tests/init/glock/case1/final/Gopkg.toml

@@ -0,0 +1,3 @@
+cmd github.com/golang/lint
+github.com/sdboyer/deptest 3f4c3bea144e112a69bbe5d8d01c1b09a544253f
+github.com/sdboyer/deptestdos 5c607206be5decd28e6263ffffdcee067266015e

cmd/dep/testdata/harness_tests/init/glock/case1/initial/GLOCKFILE

@@ -0,0 +1,16 @@
+// 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 main
+
+import (
+	"fmt"
+
+	"github.com/sdboyer/deptestdos"
+)
+
+func main() {
+	var x deptestdos.Bar
+	fmt.Println(x)
+}

cmd/dep/testdata/harness_tests/init/glock/case1/initial/main.go

@@ -0,0 +1,13 @@
+{
+  "commands": [
+    ["init", "-no-examples"]
+  ],
+  "error-expected": "",
+  "gopath-initial": {
+    "github.com/sdboyer/deptest": "3f4c3bea144e112a69bbe5d8d01c1b09a544253f"
+  },
+  "vendor-final": [
+    "github.com/sdboyer/deptest",
+    "github.com/sdboyer/deptestdos"
+  ]
+}

cmd/dep/testdata/harness_tests/init/glock/case1/testcase.json

@@ -217,7 +217,7 @@ about what's going on.
 During `dep init` configuration from other dependency managers is detected
 and imported, unless `-skip-tools` is specified.
 
-The following tools are supported: `glide`, `godep`, `vndr`, `govend`, `gb`, `gvt` and `govendor`.
+The following tools are supported: `glide`, `godep`, `vndr`, `govend`, `gb`, `gvt`, `govendor` and `glock`.
 
 See [#186](https://github.com/golang/dep/issues/186#issuecomment-306363441) for
 how to add support for another tool.

docs/FAQ.md

@@ -0,0 +1,139 @@
+// Copyright 2016 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 glock
+
+import (
+	"bufio"
+	"fmt"
+	"log"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/golang/dep"
+	"github.com/golang/dep/gps"
+	"github.com/golang/dep/internal/importers/base"
+	"github.com/pkg/errors"
+)
+
+const glockfile = "GLOCKFILE"
+
+// Importer imports glock configuration into the dep configuration format.
+type Importer struct {
+	*base.Importer
+
+	packages []glockPackage
+}
+
+// NewImporter for glock.
+func NewImporter(logger *log.Logger, verbose bool, sm gps.SourceManager) *Importer {
+	return &Importer{Importer: base.NewImporter(logger, verbose, sm)}
+}
+
+// Name of the importer.
+func (g *Importer) Name() string {
+	return "glock"
+}
+
+// HasDepMetadata checks if a directory contains config that the importer can handle.
+func (g *Importer) HasDepMetadata(dir string) bool {
+	path := filepath.Join(dir, glockfile)
+	if _, err := os.Stat(path); err != nil {
+		return false
+	}
+
+	return true
+}
+
+// Import the config found in the directory.
+func (g *Importer) Import(dir string, pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, error) {
+	err := g.load(dir)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return g.convert(pr)
+}
+
+type glockPackage struct {
+	importPath string
+	revision   string
+}
+
+func (g *Importer) load(projectDir string) error {
+	g.Logger.Println("Detected glock configuration files...")
+	path := filepath.Join(projectDir, glockfile)
+	if g.Verbose {
+		g.Logger.Printf("  Loading %s", path)
+	}
+
+	f, err := os.Open(path)
+	if err != nil {
+		return errors.Wrapf(err, "unable to open %s", path)
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	for scanner.Scan() {
+		pkg, err := parseGlockLine(scanner.Text())
+		if err != nil {
+			return err
+		}
+		if pkg == nil {
+			continue
+		}
+		g.packages = append(g.packages, *pkg)
+	}
+
+	return nil
+}
+
+func parseGlockLine(line string) (*glockPackage, error) {
+	fields := strings.Fields(line)
+	switch len(fields) {
+	case 2: // Valid.
+	case 0: // Skip empty lines.
+		return nil, nil
+	default:
+		return nil, fmt.Errorf("invalid glock configuration: %s", line)
+	}
+
+	// Skip commands.
+	if fields[0] == "cmd" {
+		return nil, nil
+	}
+	return &glockPackage{
+		importPath: fields[0],
+		revision:   fields[1],
+	}, nil
+}
+
+func (g *Importer) convert(pr gps.ProjectRoot) (*dep.Manifest, *dep.Lock, error) {
+	g.Logger.Println("Converting from GLOCKFILE ...")
+
+	packages := make([]base.ImportedPackage, 0, len(g.packages))
+	for _, pkg := range g.packages {
+		// Validate
+		if pkg.importPath == "" {
+			return nil, nil, errors.New("invalid glock configuration, import path is required")
+		}
+
+		if pkg.revision == "" {
+			return nil, nil, errors.New("invalid glock configuration, revision is required")
+		}
+
+		packages = append(packages, base.ImportedPackage{
+			Name:     pkg.importPath,
+			LockHint: pkg.revision,
+		})
+	}
+
+	err := g.ImportPackages(packages, true)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return g.Manifest, g.Lock, nil
+}