Initial release

Author: jpreese

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Plex Systems
+Copyright (c) 2019 Plex Systems, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,24 @@
 # pacmod
-Package your Go modules
+
+![logo](logo/pacmod_logo.png)
+
+[![GoDoc](https://godoc.org/github.com/plexsystems/pacmod?status.svg)](https://godoc.org/github.com/plexsystems/pacmod)
+[![Go Report Card](https://goreportcard.com/badge/github.com/plexsystems/pacmod)](https://goreportcard.com/report/github.com/plexsystems/pacmod)
+
+Pacmod is a small tool that can be used to package up your Go modules for distribution. This will be typically used for pushing artifacts to a Go module store such as [Athens](https://github.com/gomods/athens).
+
+## Installation
+
+`go get github.com/plexsystems/pacmod/cmd/pacmod`
+
+## Usage
+
+Run the `pack` command in the directory containing your `go.mod`. For example:
+
+`pacmod pack mymodule v1.0.0`
+
+This will result in the following files:
+
+- `go.mod` - The current mod file when the `pack` command was executed
+- `v1.0.0.info` - The info file containing the module version and timestamp
+- `v1.0.0.zip` - An archive containing the Go module

cmd/pacmod/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"github.com/plexsystems/pacmod/internal/commands"
+	"os"
+)
+
+func main() {
+	err := commands.NewDefaultCommand().Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/plexsystems/pacmod
+
+go 1.12
+
+require (
+	github.com/hugocarreira/go-decent-copy v0.0.0-20181018112419-9f482c9a2943
+	github.com/spf13/cobra v0.0.5
+)

go.sum

@@ -0,0 +1,35 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
+github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
+github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
+github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
+github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
+github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
+github.com/hugocarreira/go-decent-copy v0.0.0-20181018112419-9f482c9a2943 h1:uuMUrGtG7EelzCDzq7VNfexyMnbWJzHK+lA2yEHfTk8=
+github.com/hugocarreira/go-decent-copy v0.0.0-20181018112419-9f482c9a2943/go.mod h1:LGbo2Li3Ub3ZNYZHIUFZ4qfwsFNvOI+If5lpEQNYJIU=
+github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
+github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
+github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
+github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
+github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
+github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
+github.com/spf13/cobra v0.0.5 h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=
+github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
+github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
+github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
+github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
+github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
+golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

internal/commands/default.go

@@ -0,0 +1,18 @@
+package commands
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// NewDefaultCommand creates the default command
+func NewDefaultCommand() *cobra.Command {
+
+	cmd := cobra.Command{
+		Use:   "pacmod <subcommand>",
+		Short: "Command line tool to assist with packaging Go modules",
+	}
+
+	cmd.AddCommand(newPackCommand())
+
+	return &cmd
+}

internal/commands/pack.go

@@ -0,0 +1,78 @@
+package commands
+
+import (
+	"github.com/hugocarreira/go-decent-copy"
+	"github.com/plexsystems/pacmod/pkg/pack"
+	"github.com/spf13/cobra"
+	"log"
+	"os"
+	"path/filepath"
+)
+
+func newPackCommand() *cobra.Command {
+	cmd := cobra.Command{
+		Use:   "pack <module> <version>",
+		Short: "Package your Go module",
+		Args:  cobra.MinimumNArgs(2),
+
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return runPackCommand(args)
+		},
+	}
+
+	return &cmd
+}
+
+func runPackCommand(args []string) error {
+	path, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+
+	name := args[0]
+	version := args[1]
+
+	module := pack.Module{
+		Path:    path,
+		Name:    name,
+		Version: version,
+	}
+
+	outputDirectory := filepath.Join(module.Path, module.Version)
+	err = os.Mkdir(outputDirectory, 0777)
+	if err != nil {
+		return err
+	}
+
+	log.Printf("Packing module %s into output directory %s", module.Name, outputDirectory)
+
+	log.Println("Creating archive...")
+	err = module.ZipModule(outputDirectory)
+	if err != nil {
+		return err
+	}
+
+	log.Println("Creating info...")
+	info := pack.Info{
+		Version: version,
+	}
+	err = info.CreateInfo(outputDirectory)
+	if err != nil {
+		return err
+	}
+
+	log.Println("Copying mod...")
+	return copyModuleFile(module.Path, outputDirectory)
+}
+
+func copyModuleFile(source string, destination string) error {
+	sourceModFile := filepath.Join(source, "go.mod")
+	destinationModFile := filepath.Join(destination, "go.mod")
+
+	err := decentcopy.Copy(sourceModFile, destinationModFile)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

logo/pacmod_logo.png

@@ -0,0 +1,73 @@
+package pack
+
+import (
+	"archive/zip"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+// Module represents a Go module
+type Module struct {
+	Path    string
+	Name    string
+	Version string
+}
+
+// ZipModule zips the module and outputs the result to the specified output path
+func (m *Module) ZipModule(outPath string) error {
+	zipOutputPath := filepath.Join(outPath, m.Version+".zip")
+
+	zipFile, err := os.Create(zipOutputPath)
+	if err != nil {
+		return err
+	}
+	defer zipFile.Close()
+
+	zipWriter := zip.NewWriter(zipFile)
+
+	err = filepath.Walk(m.Path, func(currentFilePath string, fileInfo os.FileInfo, err error) error {
+
+		if err != nil {
+			return err
+		}
+
+		if fileInfo.IsDir() && fileInfo.Name() == ".git" {
+			return filepath.SkipDir
+		}
+
+		if fileInfo.IsDir() || filepath.Ext(currentFilePath) == ".zip" {
+			return nil
+		}
+
+		file, err := os.Open(currentFilePath)
+		if err != nil {
+			return err
+		}
+		defer file.Close()
+
+		zipPath := m.getZipPath(currentFilePath)
+		zipFileWriter, err := zipWriter.Create(zipPath)
+		if err != nil {
+			return err
+		}
+
+		_, err = io.Copy(zipFileWriter, file)
+		return err
+	})
+
+	if err != nil {
+		return err
+	}
+
+	return zipWriter.Close()
+}
+
+func (m *Module) getZipPath(currentFilePath string) string {
+	fileName := strings.TrimPrefix(currentFilePath, m.Path)
+	moduleName := fmt.Sprintf("%s@%s", m.Name, m.Version)
+
+	return filepath.Join(moduleName, fileName)
+}

pkg/pack/archive.go

@@ -0,0 +1,33 @@
+package pack
+
+import (
+	"testing"
+)
+
+func TestGetZipPath(t *testing.T) {
+	module := Module{
+		Path:    "/linux",
+		Name:    "modulename",
+		Version: "v1.0.0",
+	}
+
+	actual := module.getZipPath("/linux/file.go")
+	expected := "[email protected]\\file.go"
+
+	if actual != expected {
+		t.Errorf("Linux: expected %v, got %v", expected, actual)
+	}
+
+	module = Module{
+		Path:    "C:\\windows",
+		Name:    "modulename",
+		Version: "v1.0.0",
+	}
+
+	actual = module.getZipPath("C:\\windows\\file.go")
+	expected = "[email protected]\\file.go"
+
+	if actual != expected {
+		t.Errorf("Windows expected %v, got %v", expected, actual)
+	}
+}