heimoshuiyu/gonic
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat!: bump to go1.16 and embed version

Browse Source
This commit is contained in:
sentriz
2021-05-08 15:26:26 +01:00
committed by Senan Kelly
parent 6a99cdf299
commit 6f15589c08
16 changed files with 26 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@@ -12,8 +12,7 @@ COPY go.mod .
COPY go.sum .
RUN go mod download
COPY . .
RUN ./_do_gen_assets
RUN ./_do_build_server
RUN GOOS=linux go build -o gonic cmd/gonic/gonic.go
FROM alpine:3.13.1
RUN apk add -U --no-cache \
@@ -21,6 +20,7 @@ RUN apk add -U --no-cache \
ca-certificates \
tzdata \
tini
COPY --from=builder \
/usr/lib/libgcc_s.so.1 \
/usr/lib/libstdc++.so.6 \

2
Dockerfile.debug
View File

@@ -1,6 +1,6 @@
# syntax=docker/dockerfile:experimental
FROM golang:1.14-alpine AS builder
FROM golang:1.16-alpine AS builder
RUN apk add -U --no-cache \
build-base \
ca-certificates \

2
Dockerfile.dev
View File

@@ -1,6 +1,6 @@
# syntax=docker/dockerfile:experimental
FROM golang:1.15-alpine AS builder
FROM golang:1.16-alpine AS builder
RUN apk add -U --no-cache \
build-base \
ca-certificates \

7
TODO
View File

@@ -1,7 +0,0 @@
- gorm v2
- preload joins
- insert or ignore
- bulk inserts (eg. track_genres, album_genres, playlist stuff?)
- db package with queries encapsulated
- add newlines
- scanner tests and refactor

4
_do_build_server
View File

@@ -1,4 +0,0 @@
#!/bin/sh
# using sh, is run from alpine
go build -o gonic cmd/gonic/main.go

69
_do_bump_version
View File

@@ -1,69 +0,0 @@
#!/usr/bin/env bash
# safety checks
if [[ $# -ne 1 ]]; then
echo "usage: $0 <major|minor|patch>" >&2
exit 1
fi
if [[ "$(git rev-parse --abbrev-ref HEAD)" != 'master' ]]; then
echo "not on the master branch" >&2
exit 1
fi
# get latest and check if clean
git pull
if [[ -n "$(git status --porcelain)" ]]; then
echo "working directory is dirty" >&2
exit 1
fi
# get the current verison from last git tag into array and
# inc the provided part
semver_expression='s/^v([0-9]+)\.([0-9]+)\.([0-9]+).*$/\1 \2 \3/'
version=( $(git describe --tags | sed -E -e "$semver_expression" ) )
case "$1" in
major)
((version[0]++))
version[1]=0
version[2]=0
;;
minor)
((version[1]++))
version[2]=0
;;
patch)
((version[2]++))
;;
*)
echo 'please provide a valid version in increment' >&2
exit 1
esac
new_version="v${version[0]}.${version[1]}.${version[2]}"
# write version to go
mkdir version >/dev/null 2>&1
cat > version/version.go << EOL
// generated by \`_do_bump_version\` script in project root
// $(date)
// DO NOT EDIT
package version
const NAME = "gonic"
const NAME_UPPER = "GONIC"
const NAME_EMBED = "gonicembed"
const VERSION = "$new_version"
EOL
./_do_gen_handler_tests
# create and tag single commit with a change to the version file
git commit --all --file - << EOL
bump to $new_version
generated by \`_do_bump_version\` script in project root
EOL
git tag "$new_version"
echo "commited and tagged"
echo "remember to push tags"

20
_do_gen_assets
View File

@@ -1,20 +0,0 @@
#!/bin/sh
# using sh, is run from alpine
embed_bin_path=/tmp/gonicembed
assets_path=server/assets
# only build once for some slightly faster live page reloading
test ! -e "$embed_bin_path" && go build \
-o "$embed_bin_path" \
cmd/gonicembed/main.go
find $assets_path/ \
-type f \
! -name '*.go' \
-exec "$embed_bin_path" \
-out-path $assets_path/assets.gen.go \
-package-name assets \
-assets-var-name Bytes \
-asset-path-prefix $assets_path/ \
{} +

4
_do_run_server
View File

@@ -1,4 +0,0 @@
#!/usr/bin/env bash
./_do_gen_assets
go run cmd/gonic/main.go $@

9
_do_run_server_live
View File

@@ -1,9 +0,0 @@
#!/usr/bin/env bash
if ! command -v 'entr' > /dev/null; then
echo 'please install `entr`' >&2
echo 'http://eradman.com/entrproject/' >&2
exit 1
fi
find server/assets/ -not -name '*_gen.go' | entr -r ./_do_run_server $@

15
cmd/gonic/main.go → cmd/gonic/gonic.go
View File

@@ -15,9 +15,9 @@ import (
"github.com/oklog/run"
"github.com/peterbourgon/ff"
"go.senan.xyz/gonic"
"go.senan.xyz/gonic/server"
"go.senan.xyz/gonic/server/db"
"go.senan.xyz/gonic/version"
)
const (
@@ -27,7 +27,7 @@ const (
)
func main() {
set := flag.NewFlagSet(version.NAME, flag.ExitOnError)
set := flag.NewFlagSet(gonic.Version, flag.ExitOnError)
confListenAddr := set.String("listen-addr", "0.0.0.0:4747", "listen address (optional)")
confMusicPath := set.String("music-path", "", "path to music")
confPodcastPath := set.String("podcast-path", "", "path to podcasts")
@@ -44,17 +44,17 @@ func main() {
if err := ff.Parse(set, os.Args[1:],
ff.WithConfigFileFlag("config-path"),
ff.WithConfigFileParser(ff.PlainParser),
ff.WithEnvVarPrefix(version.NAME_UPPER),
ff.WithEnvVarPrefix(gonic.NameUpper),
); err != nil {
log.Fatalf("error parsing args: %v\n", err)
}
if *confShowVersion {
fmt.Println(version.VERSION)
fmt.Println(gonic.Version)
os.Exit(0)
}
log.Printf("starting gonic %s\n", version.VERSION)
log.Printf("starting gonic %s\n", gonic.Version)
log.Printf("provided config\n")
set.VisitAll(func(f *flag.Flag) {
log.Printf(" %-15s %s\n", f.Name, f.Value)
@@ -92,7 +92,7 @@ func main() {
proxyPrefixExpr := regexp.MustCompile(`^\/*(.*?)\/*$`)
*confProxyPrefix = proxyPrefixExpr.ReplaceAllString(*confProxyPrefix, `/$1`)
server := server.New(server.Options{
server, err := server.New(server.Options{
DB: db,
MusicPath: *confMusicPath,
CachePath: cacheDirAudio,
@@ -103,6 +103,9 @@ func main() {
HTTPLog: *confHTTPLog,
JukeboxEnabled: *confJukeboxEnabled,
})
if err != nil {
log.Fatalf("error creating server: %v\n", err)
}
var g run.Group
g.Add(server.StartHTTP(*confListenAddr))

156
cmd/gonicembed/main.go
View File

@@ -1,156 +0,0 @@
package main
import (
"flag"
"fmt"
"io"
"log"
"os"
"path/filepath"
"strings"
"github.com/peterbourgon/ff"
"go.senan.xyz/gonic/version"
)
type errWriter struct {
w io.Writer
err error
}
func (ew *errWriter) write(buf []byte) {
if ew.err != nil {
return
}
_, ew.err = ew.w.Write(buf)
}
func (ew *errWriter) printf(format string, a ...interface{}) {
if ew.err != nil {
return
}
_, ew.err = fmt.Fprintf(ew.w, format, a...)
}
func (ew *errWriter) println(a ...interface{}) {
if ew.err != nil {
return
}
_, ew.err = fmt.Fprintln(ew.w, a...)
}
// once i had this written with ~100% text/template but it was very
// slow. now this thing is not nice on the eyes or easy to change
// but it's pretty fast. which i needed it to for live reloading stuff
const (
byteCols = 24
// ** begin file template
fileHeader = `// file generated with embed tool; DO NOT EDIT.
// %s
package %s
import "time"
type EmbeddedAsset struct {
ModTime time.Time
Bytes []byte
}
var %s = map[string]*EmbeddedAsset{`
fileFooter = `
}`
// ** begin asset template
assetHeader = `
%q: &EmbeddedAsset{
ModTime: time.Unix(%d, 0),
Bytes: []byte{
`
assetFooter = `}},`
)
type config struct {
packageName string
outPath string
tagList string
assetsVarName string
assetPathPrefix string
}
func processAsset(c *config, ew *errWriter, path string) error {
info, err := os.Stat(path)
if err != nil {
return fmt.Errorf("stating asset: %w", err)
}
if info.IsDir() {
return nil
}
data, err := os.Open(filepath.Clean(path))
if err != nil {
return fmt.Errorf("opening asset: %w", err)
}
defer data.Close()
ew.write([]byte(fmt.Sprintf(assetHeader,
strings.TrimPrefix(path, c.assetPathPrefix),
info.ModTime().Unix(),
)))
buffer := make([]byte, byteCols)
for {
read, err := data.Read(buffer)
for i := 0; i < read; i++ {
ew.printf("0x%02x,", buffer[i])
}
if err != nil {
break
}
ew.println()
}
ew.write([]byte(assetFooter))
return ew.err
}
func processAssets(c *config, files []string) error {
out, err := os.Create(c.outPath)
if err != nil {
return fmt.Errorf("creating out path: %w", err)
}
ew := &errWriter{w: out}
if c.tagList != "" {
c.tagList = fmt.Sprintf("+build %s", c.tagList)
}
ew.write([]byte(fmt.Sprintf(fileHeader,
c.tagList,
c.packageName,
c.assetsVarName,
)))
defer ew.write([]byte(fileFooter))
for _, path := range files {
if err := processAsset(c, ew, path); err != nil {
return fmt.Errorf("processing asset: %w", err)
}
}
return ew.err
}
func main() {
set := flag.NewFlagSet(version.NAME_EMBED, flag.ExitOnError)
outPath := set.String("out-path", "", "generated file's path (required)")
pkgName := set.String("package-name", "assets", "generated file's package name")
tagList := set.String("tag-list", "", "generated file's build tag list")
assetsVarName := set.String("assets-var-name", "Assets", "generated assets var name")
assetPathPrefix := set.String("asset-path-prefix", "", "generated assets map key prefix")
if err := ff.Parse(set, os.Args[1:]); err != nil {
log.Fatalf("error parsing args: %v\n", err)
}
if *outPath == "" {
log.Fatalln("invalid arguments. see -h")
}
c := &config{
packageName: *pkgName,
outPath: *outPath,
tagList: *tagList,
assetsVarName: *assetsVarName,
assetPathPrefix: *assetPathPrefix,
}
if err := processAssets(c, set.Args()); err != nil {
log.Fatalf("error processing files: %v\n", err)
}
}

2
_do_gen_handler_tests → gen_handler_tests
View File

@@ -10,7 +10,7 @@ test_cache_path="$(mktemp -d)"
mkdir "$test_music_path" 2>/dev/null
echo "waiting for server to start"
./_do_run_server \
go run cmd/gonic/gonic.go \
-music-path "$test_music_path" \
-podcast-path "$test_podcast_path" \
-cache-path "$test_cache_path" \

4
go.mod
View File

@@ -1,5 +1,7 @@
module go.senan.xyz/gonic
go 1.16
require (
github.com/Masterminds/goutils v1.1.0 // indirect
github.com/Masterminds/semver v1.5.0 // indirect
@@ -39,5 +41,3 @@ require (
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
gopkg.in/gormigrate.v1 v1.6.0
)
go 1.15

9
version.go Normal file
View File

@@ -0,0 +1,9 @@
//nolint:gochecknoglobals,golint,stylecheck
package gonic
import (
_ "embed"
)
//go:embed version.txt
var Version string

1
version.txt Normal file
View File

@@ -0,0 +1 @@
0.12.2

10
version/version.go
View File

@@ -1,10 +0,0 @@
// generated by `_do_bump_version` script in project root
// Tue 20 Apr 2021 23:16:59 IST
// DO NOT EDIT
package version
const NAME = "gonic"
const NAME_UPPER = "GONIC"
const NAME_EMBED = "gonicembed"
const VERSION = "v0.12.3"