regiontag_test.go

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package samples

import (
	"bufio"
	"log"
	"os/exec"
	"regexp"
	"sync"
	"testing"
)

var startRe = regexp.MustCompile("\\[START ([[:word:]]+)\\]")

func listPackages() <-chan string {
	c := make(chan string)
	go func() {
		cmd := exec.Command("go", "list", "./...")
		out, err := cmd.StdoutPipe()
		if err != nil {
			log.Fatal(err)
		}

		if err = cmd.Start(); err != nil {
			log.Fatal(err)
		}

		scanner := bufio.NewScanner(out)
		for scanner.Scan() {
			c <- scanner.Text()
		}
		close(c)
	}()
	return c
}

type RegionTag struct {
	file string
	line string
}

func findRegionTags(pkgs <-chan string) <-chan RegionTag {
	c := make(chan RegionTag)
	go func() {
		for p := range pkgs {
			goDoc := exec.Command("go", "doc", p)
			out, err := goDoc.StdoutPipe()
			if err != nil {
				log.Fatal(err)
			}

			if err = goDoc.Start(); err != nil {
				log.Fatal(err)
			}

			scanner := bufio.NewScanner(out)

			// filter affected lines only
			for scanner.Scan() {
				text := scanner.Text()
				if !startRe.MatchString(text) {
					continue
				}
				c <- RegionTag{file: p, line: text}
			}
		}
		close(c)
	}()
	return c
}

func merge(cs ...<-chan RegionTag) <-chan RegionTag {
	var wg sync.WaitGroup
	out := make(chan RegionTag)

	output := func(c <-chan RegionTag) {
		for n := range c {
			out <- n
		}
		wg.Done()
	}
	wg.Add(len(cs))
	for _, c := range cs {
		go output(c)
	}

	go func() {
		wg.Wait()
		close(out)
	}()
	return out
}

func TestRegionTags(t *testing.T) {

	in := listPackages()
	const workers = 4

	var cs [workers]<-chan RegionTag
	for i := 0; i < workers; i++ {
		cs[i] = findRegionTags(in)
	}

	for tag := range merge(cs[:]...) {
		t.Errorf("\nFile: %v\nLine: %#v", tag.file, tag.line)
	}
}