Kadai2 Hiroya-W

kadai2/hiroya-w/.gitignore

@@ -0,0 +1,5 @@
+# binaries
+bin/
+
+# coverage outputs
+coverage.out

kadai2/hiroya-w/Makefile

@@ -0,0 +1,57 @@
+NAME := imgconv
+VERSION := $(gobump show -r)
+REVISION := $(shell git rev-parse --short HEAD)
+LDFLAGS := "-X main.revision=$(REVISION)"
+
+## Install dependencies
+.PHONY: deps
+deps:
+	go get -v -d
+
+## Setup
+.PHONY: devel-deps
+devel-deps: devel-deps
+	go install honnef.co/go/tools/cmd/staticcheck@latest
+	go install github.com/kisielk/errcheck@latest
+	go install github.com/x-motemen/gobump/cmd/gobump@latest
+	go install github.com/Songmu/make2help/cmd/make2help@latest
+
+## Run tests
+.PHONY: test
+test: deps
+	go test -v -race -cover -coverprofile=coverage.out ./...
+
+## Generate testdatas
+.PHONY: test-deps
+test-deps:
+	cd _tools && sh gen_testdata.sh ../testdata
+
+## Show coverage
+.PHONY: cover
+cover:
+	go tool cover -html=coverage.out
+
+## Lint
+.PHONY: lint
+lint: deps
+	go vet ./...
+	staticcheck ./...
+	errcheck -ignore 'fmt:[FS]?[Pp]rint*' ./...
+
+## build binaries
+bin/%: cmd/%/main.go deps
+	go build -ldflags $(LDFLAGS) -o $@ $<
+
+## build binary
+.PHONY: build
+build: bin/imgconv
+
+## show go documention
+.PHONY: doc
+doc:
+	godoc -http=:8080
+
+## Show help
+.PHONY: help
+help:
+	@make2help $(MAKEFILE_LIST)

kadai2/hiroya-w/README.md

@@ -0,0 +1,64 @@
+# 課題2
+
+## テストを書いてみよう
+
+- [x] テストのしやすさを考えてリファクタリングしてみる
+- [x] テストのカバレッジを取ってみる
+- [x] テーブル駆動テストを行う
+- [ ] テストヘルパーを作ってみる
+
+今回のテストで、どの部分にテストヘルパーを利用出来るのかがわからなかった。他の方のPRを参考に眺めてみようと思う。
+Goでオブジェクト指向をしようとしてハマるやつをやりかけてしまっているように感じたので、もう少しGoらしい書き方を勉強してもいいなと思った。
+
+## usage
+
+```
+.bin/imgconv -h
+Usage of .bin/imgconv:
+  -input-type string
+        input type[jpg|jpeg|png|gif] (default "jpg")
+  -output-type string
+        output type[jpg|jpeg|png|gif] (default "png")
+```
+
+基本的なコマンドは `Makefile` で利用できます。
+
+### build
+
+ビルドに必要なパッケージを取得します。
+
+```
+make devel-deps
+```
+
+ビルドすると `bin` フォルダに `imgconv` のバイナリが生成されます。
+
+```
+make build
+```
+
+### test
+
+`testdata` にテスト用の画像を生成します。
+その後、 `make test` でテストを実行します。
+
+```
+make test-deps
+make test
+```
+
+### coverage
+
+テストの実行後、カバレッジを表示します。
+
+```
+make cover
+```
+
+### document
+
+ドキュメントを表示します。
+
+```
+make doc
+```

kadai2/hiroya-w/_tools/gen_testdata.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+DIR=${1:-.}
+
+curl https://avatars.githubusercontent.com/hiroya-w -o $DIR/image_png.png
+curl http://icb-lab.naist.jp/members/yoshi/ouec_lecture/image_recognition/image_files/lena.jpg -o $DIR/image_jpg.jpg
+curl https://upload.wikimedia.org/wikipedia/commons/2/2c/Rotating_earth_%28large%29.gif -o $DIR/image_gif.gif

kadai2/hiroya-w/cli.go

@@ -0,0 +1,91 @@
+package imgconv
+
+import (
+	"flag"
+	"fmt"
+	"io"
+	"os"
+)
+
+// CLI is the command line interface
+type CLI struct {
+	OutStream, ErrStream io.Writer
+}
+
+// validateType validates the type of the image
+func validateType(t string) error {
+	switch t {
+	case "jpg", "jpeg", "png", "gif":
+		return nil
+	default:
+		return fmt.Errorf("invalid type: %s", t)
+	}
+}
+
+// Run parses the command line arguments and runs the imgConv
+func (cli *CLI) Run() int {
+	config := &Config{}
+	fs := flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
+	fs.StringVar(&config.InputType, "input-type", "jpg", "input type[jpg|jpeg|png|gif]")
+	fs.StringVar(&config.OutputType, "output-type", "png", "output type[jpg|jpeg|png|gif]")
+	fs.SetOutput(cli.ErrStream)
+	fs.Usage = func() {
+		fmt.Fprintf(cli.ErrStream, "Usage: %s [options] DIRECTORY\n", "imgconv")
+		fs.PrintDefaults()
+	}
+
+	if err := fs.Parse(os.Args[1:]); err != nil {
+		fmt.Fprintf(cli.ErrStream, "Error parsing arguments: %s\n", err)
+		return 1
+	}
+
+	if err := validateType(config.InputType); err != nil {
+		fmt.Fprintf(cli.ErrStream, "invalid input type: %s\n", err)
+		return 1
+	}
+
+	if err := validateType(config.OutputType); err != nil {
+		fmt.Fprintf(cli.ErrStream, "invalid output type: %s\n", err)
+		return 1
+	}
+
+	if config.InputType == config.OutputType {
+		fmt.Fprintf(cli.ErrStream, "input type and output type must be different\n")
+		return 1
+	}
+
+	if fs.Arg(0) == "" {
+		fmt.Fprintf(cli.ErrStream, "directory is required\n")
+		return 1
+	}
+
+	config.Directory = fs.Arg(0)
+
+	dec, err := NewDecoder(config.InputType)
+	if err != nil {
+		fmt.Fprintf(cli.ErrStream, "failed to create decoder: %s\n", err)
+		return 1
+	}
+	enc, err := NewEncoder(config.OutputType)
+	if err != nil {
+		fmt.Fprintf(cli.ErrStream, "failed to create encoder: %s\n", err)
+		return 1
+	}
+	imgConv := &ImgConv{
+		Decoder:   dec,
+		Encoder:   enc,
+		TargetDir: config.Directory,
+	}
+	convertedFiles, err := imgConv.Run()
+	if err != nil {
+		fmt.Fprintf(cli.ErrStream, "failed to convert images: %s\n", err)
+		return 1
+	}
+
+	fmt.Fprintf(cli.OutStream, "converted %d files\n", len(convertedFiles))
+	for _, f := range convertedFiles {
+		fmt.Fprintf(cli.OutStream, "%s\n", f)
+	}
+
+	return 0
+}

kadai2/hiroya-w/cli_test.go

@@ -0,0 +1,46 @@
+package imgconv_test
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"strings"
+	"testing"
+
+	imgconv "github.com/Hiroya-W/gopherdojo-studyroom/kadai2/hiroya-w"
+)
+
+func TestCLI(t *testing.T) {
+	// t.Parallel()
+	tests := []struct {
+		options    string
+		exitStatus int
+		want       string
+	}{
+		{options: "", exitStatus: 1, want: "directory is required"},
+		{options: "-h", exitStatus: 1, want: "Usage"},
+		{options: "-input-type=bmp testdata", exitStatus: 1, want: "invalid input type:"},
+		{options: "-output-type=tiff testdata", exitStatus: 1, want: "invalid output type:"},
+		{options: "-input-type=jpg -output-type=jpg testdata", exitStatus: 1, want: "input type and output type must be different"},
+		{options: "testdata", exitStatus: 0, want: ""},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(fmt.Sprintf("Options:'%s'", test.options), func(t *testing.T) {
+			outStream, errStream := new(bytes.Buffer), new(bytes.Buffer)
+			cli := &imgconv.CLI{OutStream: outStream, ErrStream: errStream}
+
+			os.Args = append([]string{os.Args[0]}, strings.Split(test.options, " ")...)
+			exitStatus := cli.Run()
+
+			if exitStatus != test.exitStatus {
+				t.Errorf("exit status = %d, want %d", exitStatus, test.exitStatus)
+			}
+
+			if !strings.Contains(errStream.String(), test.want) {
+				t.Errorf("expected %q to eq %q", errStream.String(), test.want)
+			}
+		})
+	}
+}

kadai2/hiroya-w/cmd/imgconv/main.go

@@ -0,0 +1,12 @@
+package main
+
+import (
+	"os"
+
+	imgconv "github.com/Hiroya-W/gopherdojo-studyroom/kadai2/hiroya-w"
+)
+
+func main() {
+	cli := &imgconv.CLI{OutStream: os.Stdout, ErrStream: os.Stderr}
+	os.Exit(cli.Run())
+}

kadai2/hiroya-w/go.mod

@@ -0,0 +1,3 @@
+module github.com/Hiroya-W/gopherdojo-studyroom/kadai2/hiroya-w
+
+go 1.17