main.go

package main

import (
	"context"
	"fmt"
	"net"
	"os"
	"strings"

	"github.com/agilepathway/gauge-confluence/gauge_messages"
	"github.com/agilepathway/gauge-confluence/internal/confluence"
	"github.com/agilepathway/gauge-confluence/internal/logger"
	"github.com/agilepathway/gauge-confluence/util"
	"google.golang.org/grpc"
)

const (
	gaugeSpecsDir = "GAUGE_SPEC_DIRS"
	gaugeLogLevel = "GAUGE_LOG_LEVEL"
	fileSeparator = "||"
)

var (
	projectRoot = util.GetProjectRoot() //nolint:gochecknoglobals
)

type handler struct {
	server *grpc.Server
}

func (h *handler) GenerateDocs(c context.Context, m *gauge_messages.SpecDetails) (*gauge_messages.Empty, error) {
	publisher := confluence.NewPublisher(m)
	err := publisher.Publish(providedSpecsPaths())

	return &gauge_messages.Empty{}, err
}

func (h *handler) Kill(c context.Context, m *gauge_messages.KillProcessRequest) (*gauge_messages.Empty, error) {
	defer h.stopServer()
	return &gauge_messages.Empty{}, nil
}

func (h *handler) stopServer() {
	h.server.Stop()
}

func main() {
	logger.Initialize(loglevel())

	err := os.Chdir(projectRoot)
	util.Fatal("failed to change directory to project root.", err)

	address, err := net.ResolveTCPAddr("tcp", "127.0.0.1:0")
	util.Fatal("failed to start server.", err)

	l, err := net.ListenTCP("tcp", address)
	util.Fatal("TCP listening failed.", err)

	server := grpc.NewServer(grpc.MaxRecvMsgSize(1024 * 1024 * 10)) //nolint:gomnd
	h := &handler{server: server}
	gauge_messages.RegisterDocumenterServer(server, h)
	fmt.Printf("Listening on port:%d /n", l.Addr().(*net.TCPAddr).Port)
	server.Serve(l) //nolint:errcheck,gosec
}

// providedSpecsPaths returns the specs paths passed in
// by the user of the plugin (converted to absolute paths by the
// core Gauge engine).
// Each spec path can be a directory or a spec file, as the `gauge docs`
// command accepts arguments in the same way as `gauge run`:
// https://docs.gauge.org/execution.html#multiple-arguments-passed-to-gauge-run
func providedSpecsPaths() []string {
	return strings.Split(os.Getenv(gaugeSpecsDir), fileSeparator)
}

// loglevel returns the log level if set by the plugin user, or an empty string if not.
// The plugin user can set the log level via the `GAUGE_LOG_LEVEL` environment variable.
// (Gauge does not currently pass on the command line `-l, --log-level` flag to plugins,
// so the plugin does not currently respect the command line flag but does respect the
// above environment variable).
// If the log level is not set by the user then the level defaults to info.
func loglevel() string {
	return os.Getenv(gaugeLogLevel)
}