Netpulse_SasS/agent/internal/ncmx/commands.go

package ncmx

import (
	"bytes"
	"context"
	"crypto/sha256"
	"encoding/json"
	"fmt"
	"strings"
	"time"

	npv1 "github.com/netpulse/netpulse/gen/go/netpulse/v1"
)

// Виконання довільних команд — той самий сеанс, що й збір конфігу, з
// однією відмінністю: тут цікавий вивід КОЖНОЇ команди, а не лише
// останньої.
//
// Через це Collect тут не годиться, хоч і робить майже те саме: у ньому
// вивід підготовчих команд свідомо відкидається, а результат проходить
// перевірку «схоже на конфіг». Обидва рішення правильні для бекапу й
// обидва хибні тут: `display cpu` не схожий на конфіг і ніколи не
// пройде looksLikeConfig, а вивід підготовчої команди — єдине місце, де
// видно, що консоль так і лишилась посторінковою.

// Outcome — результат однієї команди.
type Outcome struct {
	Command string `json:"command"`
	Output  string `json:"output"`
	Error   string `json:"error,omitempty"`
}

// CommandReport — тіло, яке їде на сервер замість тексту конфігу.
//
// JSON, а не суцільний текст із роздільниками: питання до результату
// завжди адресне («що відповіла ОЦЯ команда»), і різати спільний потік
// назад на команди означало б удруге робити роботу, яку ми вже зробили
// тут — до того ж навгад, бо роздільник може трапитись і у виводі.
type CommandReport struct {
	Outcomes []Outcome `json:"outcomes"`
	// Чому послідовність обірвалась. Порожнє — усі команди відпрацювали.
	Error string `json:"error,omitempty"`
}

// RunCommands виконує всі команди завдання й повертає вивід кожної.
//
// Помилку повертає лише тоді, коли розповідати нічого: не під'єднались,
// не дочекались привітання. Усе, що сталося після входу, — це вміст
// звіту, а не відмова: половина виводу теж відповідь, і саме в ній
// зазвичай видно, чому впала друга половина.
func RunCommands(ctx context.Context, job *npv1.ConfigJob) (Result, error) {
	start := time.Now()

	if len(job.GetCommands()) == 0 {
		return Result{}, fmt.Errorf("завдання без жодної команди")
	}

	promptRe, err := compilePrompt(job.GetPromptRegex())
	if err != nil {
		return Result{}, err
	}

	timeout := job.GetTimeout().AsDuration()
	if timeout <= 0 {
		timeout = 2 * time.Minute
	}
	ctx, cancel := context.WithTimeout(ctx, timeout)
	defer cancel()

	cred := job.GetCredential()

	var transcript *bytes.Buffer
	if job.GetCaptureTranscript() {
		transcript = &bytes.Buffer{}
	}

	conn, err := Dial(ctx, transportName(job.GetTransport()),
		job.GetDevice().GetAddress(), int(job.GetPort()),
		cred.GetUsername(), password(cred), privateKey(cred),
		connectTimeout(timeout), transcript)
	if err != nil {
		return withTranscript(Result{}, transcript), err
	}
	defer conn.Close()

	cli := NewCLI(conn, Options{
		PromptRe:   promptRe,
		MaxBytes:   int(job.GetMaxBytes()),
		Transcript: transcript,
	})

	if err := cli.WaitPrompt(ctx); err != nil {
		return withTranscript(Result{}, transcript),
			fmt.Errorf("привітання пристрою: %w", err)
	}

	if job.GetEnableRequired() {
		if err := enable(ctx, cli, cred.GetEnablePassword()); err != nil {
			return withTranscript(Result{}, transcript), err
		}
	}

	rep := runCommandLoop(ctx, cli, job.GetCommands())

	body, err := json.Marshal(rep)
	if err != nil {
		return withTranscript(Result{}, transcript), err
	}
	sum := sha256.Sum256(body)

	res := Result{
		Body:      body,
		SHA256:    sum[:],
		LineCount: len(rep.Outcomes),
		Duration:  time.Since(start),
	}
	return withTranscript(res, transcript), nil
}

// runCommandLoop проганяє команди по черзі й збирає вивід кожної.
//
// Окремо від RunCommands, щоб перевірятись без мережі: усе, що варте
// перевірки, відбувається саме тут, а Dial із живим сокетом у тест не
// затягнеш.
func runCommandLoop(ctx context.Context, cli *CLI, commands []string) CommandReport {
	rep := CommandReport{Outcomes: make([]Outcome, 0, len(commands))}

	for _, cmd := range commands {
		out, err := cli.Run(ctx, cmd)
		oc := Outcome{Command: cmd, Output: strings.TrimRight(out, "\n")}
		if err != nil {
			oc.Error = err.Error()
			rep.Outcomes = append(rep.Outcomes, oc)
			// Далі не йдемо. Не дочекались запрошення — означає, що
			// пристрій ще щось пише або чекає на щось інше; наступна
			// команда пішла б у невідомо який контекст, а її вивід
			// приписався б не тій команді.
			rep.Error = fmt.Sprintf("команда %q: %v", cmd, err)
			break
		}
		rep.Outcomes = append(rep.Outcomes, oc)
	}
	return rep
}