unconvert_test.go

// Copyright 2019 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package main_test

import (
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"sort"
	"strconv"
	"strings"
	"testing"
)

func TestBinary(t *testing.T) {
	exePath := build(t)

	tests := []struct {
		name string
		dir  string
		args []string
	}{
		{"relative", ".", []string{"./testdata"}},
		{"dot", "./testdata", []string{"."}},
		{"no-args", "./testdata", []string{}},
		{"pattern", "./testdata", []string{"./..."}},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			cmd := exec.Command(exePath, test.args...)
			cmd.Dir = test.dir

			output, err := cmd.CombinedOutput()
			if err == nil {
				t.Fatal("expected to quit with an error code")
			}
			t.Log(string(output))

			got, err := ParseOutput(t, "testdata", string(output))
			if err != nil {
				t.Fatal(err)
			}

			expected, err := ParseDir("testdata")
			if err != nil {
				t.Fatal(err)
			}

			SortAnnotations(got)
			SortAnnotations(expected)

			need := map[Annotation]struct{}{}
			for _, annotation := range expected {
				need[annotation] = struct{}{}
			}

			for _, annotation := range got {
				_, ok := need[annotation]
				if ok {
					delete(need, annotation)
				} else {
					t.Errorf("unexpected: %v", annotation)
				}
			}

			for _, annotation := range expected {
				_, ok := need[annotation]
				if ok {
					t.Errorf("missing: %v", annotation)
				}
			}
		})
	}
}

type Annotation struct {
	File    string
	Line    int
	Message string
}

func SortAnnotations(annotations []Annotation) {
	sort.Slice(annotations, func(i, j int) (x bool) {
		ai, aj := &annotations[i], &annotations[j]
		if ai.File != aj.File {
			return ai.File < aj.File
		}
		if ai.Line != aj.Line {
			return ai.Line < aj.Line
		}
		return ai.Message < aj.Message
	})
}

func (ann Annotation) String() string {
	return fmt.Sprintf("%s:%d: %s", ann.File, ann.Line, ann.Message)
}

func ParseOutput(t *testing.T, dir, output string) ([]Annotation, error) {
	var all []Annotation
	for _, line := range strings.Split(output, "\n") {
		line = strings.TrimSpace(line)
		if line == "" {
			continue
		}

		folderStart := strings.Index(line, dir)
		if folderStart < 0 {
			t.Errorf("unexpected: %s", line)
			continue
		}

		line = line[folderStart+len(dir)+1:]
		tokens := strings.SplitN(line, ":", 4)
		if len(tokens) != 4 {
			t.Errorf("unexpected: %s", line)
			continue
		}

		line, err := strconv.Atoi(tokens[1])
		if err != nil {
			return nil, err
		}

		all = append(all, Annotation{
			File:    tokens[0],
			Line:    line,
			Message: strings.TrimSpace(tokens[3]),
		})
	}
	return all, nil
}

func ParseDir(dir string) ([]Annotation, error) {
	var all []Annotation
	files, err := os.ReadDir(dir)
	if err != nil {
		return nil, err
	}
	for _, file := range files {
		if filepath.Ext(file.Name()) != ".go" {
			continue
		}

		xs, err := ParseFile(filepath.Join(dir, file.Name()))
		if err != nil {
			return all, err
		}
		all = append(all, xs...)
	}

	return all, nil
}

func ParseFile(file string) ([]Annotation, error) {
	data, err := os.ReadFile(file)
	if err != nil {
		return nil, err
	}

	filename := filepath.Base(file)

	var all []Annotation
	for lineNumber, line := range strings.Split(string(data), "\n") {
		p := strings.Index(line, "//@")
		if p < 0 {
			continue
		}

		all = append(all, Annotation{
			File:    filename,
			Line:    lineNumber + 1,
			Message: strings.TrimSpace(line[p+3:]),
		})
	}

	return all, nil
}

func build(t *testing.T) (exePath string) {
	exePath = filepath.Join(t.TempDir(), "test_unconvert.exe")

	output, err := exec.Command("go", "build", "-o", exePath, ".").CombinedOutput()
	if err != nil {
		t.Fatalf("failed to build service program: %v\n%v", err, string(output))
	}

	return exePath
}