goproxy

README

GoProxy middleware

Middleware for go modules proxy, inspired by https://github.com/goproxyio/goproxy

Usage

How to set up a middleware:

1. Initiate router:

   r, err := goproxy.NewRouter()
   

2. Add needed handlers via

   err := r.AddRoute(plugin)
   

   for example:

   regular, err := vcs.NewPlugin(cacheDir)
   if err != nil {
       log.Fatal(err)
   }
   if err := r.AddRoute("", regular); err != nil {
       log.Fatal(err)
   }
   

   this library currently supports vcs which is pretty much like regular go get (regular in the example), gitlab which works upon gitlab's v4 API and delegation to another go proxy, see source/...
3. Generate middleware:

   var m http.Handler = goproxy.Middleware(r)
   

   Now you can use it in your HTTP server See examples/goproxy for details

Example

There's an example which supports regular go get-like module retrieval and gitlab.

1. Build it:

   go build ./examples/goproxy
   

2. Start it:

   ./goproxy -cache-dir . -gitlab https://gitlab.com/api/v4 -listen 0.0.0.0:8081
   

3. Set up environment:

   export GO111MODULE=on
   export GOPROXY=http://<gitlab private token>@localhost:8081
   

   Remember, you must generate gitlab private token first otherwise gitlab may reject your requests

Documentation

Index

• func GetModInfo(req *http.Request, prefix string) (path string, suffix string, err error)
• func Middleware(r *Router, transportPrefix string, logger *zerolog.Logger) http.Handler
• func PathEncoding(path string) (string, error)
• type Module
• type Plugin
• type RevInfo
• type Router
  • func NewRouter() (*Router, error)
  • func (r *Router) AddRoute(mask string, f Plugin) error
  • func (r *Router) Factory(path string) Plugin

Functions

func GetModInfo

func GetModInfo(req *http.Request, prefix string) (path string, suffix string, err error)

GetModInfo retrieves mod info from URL

func Middleware

func Middleware(r *Router, transportPrefix string, logger *zerolog.Logger) http.Handler

Middleware acts as go proxy with given router.

transportPrefix is a head part of URL path which refers to address of go proxy before the module info. For example,

if we serving go proxy at https://0.0.0.0:8081/goproxy/..., transportPrefix will be "/goproxy"

func PathEncoding

func PathEncoding(path string) (string, error)

PathEncoding returns go module encoded path

Types

type Module

type Module interface {
	// ModulePath returns the module path.
	ModulePath() string

	// Versions lists all known versions with the given prefix.
	// Pseudo-versions are not included.
	// Versions should be returned sorted in semver order
	// (implementations can use SortVersions).
	Versions(ctx context.Context, prefix string) (tags []string, err error)

	// Stat returns information about the revision rev.
	// A revision can be any identifier known to the underlying service:
	// commit hash, branch, tag, and so on.
	Stat(ctx context.Context, rev string) (*RevInfo, error)

	// GoMod returns the go.mod file for the given version.
	GoMod(ctx context.Context, version string) (data []byte, err error)

	// Zip returns file reader of ZIP file for the given version of the module
	Zip(ctx context.Context, version string) (file io.ReadCloser, err error)
}

Module represents go module: some VSC (git, mercurial, svn, etc), Gitlab, another Go modules proxy, etc

type Plugin

type Plugin interface {
	Module(req *http.Request, prefix string) (Module, error)
	Leave(source Module) error
	Close() error
	String() string
}

Plugin gives a way to get a source object for a request

type RevInfo

type RevInfo struct {
	Version string // version string
	Time    string // commit time

	// These fields are used for Stat of arbitrary rev,
	// but they are not recorded when talking about module versions.
	Name  string `json:"-"` // complete ID in underlying repository
	Short string `json:"-"` // shortened ID, for use in pseudo-version
}

RevInfo describes a single revision of a module source

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router routes to some plugin

func NewRouter

func NewRouter() (*Router, error)

NewRouter ...

func (*Router) AddRoute

func (r *Router) AddRoute(mask string, f Plugin) error

AddRoute add plugin for a given path mask

func (*Router) Factory

func (r *Router) Factory(path string) Plugin

Plugin returns plugin for given route