golang-index

golang-index is a service which serves a feed of new module versions for private modules hosted on GitHub Enterprise. More detailed information about the response formats and other details can be found at https://index.golang.org/.

Standing up postgres

Running the binary & tests requires standing up postgres:

export POSTGRES_USERNAME=postgres
export POSTGRES_PASSWORD=postgres
export POSTGRES_HOST=127.0.0.1
export POSTGRES_PORT=55432 # In case 5432 is in use already.
export POSTGRES_DB=index
docker run \
    -e POSTGRES_USERNAME=$POSTGRES_USERNAME \
    -e POSTGRES_PASSWORD=$POSTGRES_PASSWORD \
    -e POSTGRES_DB=$POSTGRES_DB \
    -p "$POSTGRES_PORT:5432" \
    -d postgres

Running the app

# Stand up postgres.
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
migrate -source file://migrations -database "postgres://$POSTGRES_USERNAME:$POSTGRES_PASSWORD@$POSTGRES_HOST:$POSTGRES_PORT/$POSTGRES_DB?sslmode=disable" up
go run . -githubHostName=... -githubAuthToken=...

Running tests

Running tests requires a running Postgres, with migrations run, and providing environment variables as follows:

# Stand up postgres.
go test ./... -v # Note: tests run migrations automatically.

Connect to psql for debugging:

PGPASSWORD=$POSTGRES_PASSWORD psql -h $POSTGRES_HOST -p $POSTGRES_PORT -d index -U $POSTGRES_USERNAME
# Tip: List tables with \d. Quit with \q.