Categorygithub.com/rogpeppe/go-internal
module
1.14.1
Repository: https://github.com/rogpeppe/go-internal.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

This repository factors out an opinionated selection of internal packages and functionality from the Go standard library. Currently this consists mostly of packages and testing code from within the Go tool implementation.

This repo is primarily maintained by long-time Go contributors who are also currently maintaining CUE (which is primarily written in Go and which relies upon several of the packages here).

Contributions are welcome, but please open an issue for discussion first.

Packages

Included are the following:

  • goproxytest: a GOPROXY implementation designed for test use.
  • gotooltest: Use the Go tool inside test scripts (see testscript below)
  • imports: list of known architectures and OSs, and support for reading import statements.
  • par: do work in parallel.
  • testenv: information on the current testing environment.
  • testscript: script-based testing based on txtar files
  • txtar: simple text-based file archives for testing.

Note that most users of txtar should use https://pkg.go.dev/golang.org/x/tools/txtar instead. Our package will be replaced by it once https://github.com/golang/go/issues/59264 is fixed.

testscript

The most popular package here is the testscript package:

  • Provides a shell-like test environment that is very nicely tuned for testing Go CLI commands.
  • Extracted from the core Go team's internal testscript package (cmd/go/internal/script), which is heavily used to test the go command.
  • Supports patterns for checking stderr/stdout, command pass/fail assertions, and so on.
  • Integrates well with go test, including coverage support.
  • Inputs and sample output files can use the simple txtar text archive format, also used by the Go playground.
  • Allows automatically updating golden files.
  • Built-in support for Go concepts like build tags.
  • Accompanied by a testscript command for running standalone scripts with files embedded in txtar format.

A nice introduction to using testscripts is this blog post series. Both testscript and txtar were originally created by Russ Cox.

# Packages

Package cache implements a build artifact cache.
No description provided by the author
No description provided by the author
Package dirhash is a thin forwarding layer on top of [golang.org/x/mod/sumdb/dirhash].
Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages.
Package goproxytest serves Go modules from a proxy server designed to run on localhost during tests, both to make tests avoid requiring specific network servers and also to make them significantly faster.
Package gotooltest implements functionality useful for testing tools that use the go command.
No description provided by the author
Package lockedfile creates and manipulates files whose contents should only change atomically.
Package modfile implements parsing and formatting for go.mod files.
Package module is a thin forwarding layer on top of [golang.org/x/mod/module].
Package par implements parallel execution helpers.
Package renameio writes files atomically by renaming temporary files.
Package robustio wraps I/O functions that are prone to failure on Windows, transparently retrying errors up to an arbitrary timeout.
Package semver is a thin forwarding layer on top of [golang.org/x/mod/semver].
Package testenv provides information about what functionality is available in different testing environments run by the Go team.
Package testscript provides support for defining filesystem-based tests by creating scripts in a directory.
Package txtar implements a trivial text-based file archive format.