telegram-exporter/internal/remote/fs_test.go

package remote

import (
	"context"
	"os"
	"os/exec"
	"slices"
	"strings"
	"testing"

	"github.com/rclone/rclone/fs"
)

// Resolve's own validation runs before rclone is consulted, so these cases are
// checkable without a config file or a network.
func TestResolveRejectsMalformedDestinations(t *testing.T) {
	tests := []struct {
		name   string
		remote string
		want   string
	}{
		{"empty", "", "destination remote is required"},
		{"no colon", "pikpak", "not in rclone REMOTE:PATH form"},
		{"path only", "/tmp/staging", "not in rclone REMOTE:PATH form"},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			_, err := Resolve(context.Background(), tt.remote)
			if err == nil {
				t.Fatalf("Resolve(%q) succeeded, want an error", tt.remote)
			}
			if !strings.Contains(err.Error(), tt.want) {
				t.Errorf("Resolve(%q) error = %v, want it to mention %q", tt.remote, err, tt.want)
			}
		})
	}
}

// Forms rclone accepts must not be rejected by our own pre-checks. An earlier
// version screened the name against the config file's sections, which turned
// away env-defined remotes, connection strings, and parameterised names that
// rclone resolves perfectly well. These must get past our validation and fail —
// if at all — inside rclone, on their own merits.
func TestResolveDefersUnusualFormsToRclone(t *testing.T) {
	forms := []string{
		"pikpak,chunk_size=10M:mychannel", // parameterised remote name
		":local:/tmp",                     // inline connection string
		"envonly:bucket",                  // possibly defined by RCLONE_CONFIG_ENVONLY_*
	}

	for _, form := range forms {
		t.Run(form, func(t *testing.T) {
			_, err := Resolve(context.Background(), form)
			if err == nil {
				return // rclone resolved it; nothing to assert
			}
			if strings.Contains(err.Error(), "not in rclone REMOTE:PATH form") {
				t.Errorf("Resolve(%q) was rejected by our own syntax check; "+
					"rclone should be the authority on what resolves: %v", form, err)
			}
		})
	}
}

func TestDefaultTunablesMatchPikpakSettings(t *testing.T) {
	// These two numbers are the outcome of debugging pikpak's async-commit
	// behaviour in the shell pipeline; a silent change would reintroduce
	// transfers that fail while the server is still committing.
	got := DefaultTunables()
	if got.Transfers != 2 {
		t.Errorf("Transfers = %d, want 2", got.Transfers)
	}
	if got.LowLevelRetries != 20 {
		t.Errorf("LowLevelRetries = %d, want 20", got.LowLevelRetries)
	}
}

func TestInitAppliesTunables(t *testing.T) {
	// Unset both so the defaults, not an operator override, are what lands.
	unset(t, "RCLONE_TRANSFERS")
	unset(t, "RCLONE_LOW_LEVEL_RETRIES")

	ctx, err := Init(context.Background(), Tunables{Transfers: 2, LowLevelRetries: 20})
	if err != nil {
		t.Fatalf("Init: %v", err)
	}
	ci := fs.GetConfig(ctx)
	if ci.Transfers != 2 {
		t.Errorf("ctx Transfers = %d, want 2", ci.Transfers)
	}
	if ci.LowLevelRetries != 20 {
		t.Errorf("ctx LowLevelRetries = %d, want 20", ci.LowLevelRetries)
	}
}

// rclone reads RCLONE_TRANSFERS into its global config at package init, so an
// in-process t.Setenv cannot observe whether Init honours it — the assertion
// would pass with the guard removed. A subprocess is the only real check.
func TestInitLeavesEnvOverridesAlone(t *testing.T) {
	if os.Getenv("GO_INIT_ENV_CHILD") == "1" {
		ctx, err := Init(t.Context(), Tunables{Transfers: 2, LowLevelRetries: 20})
		if err != nil {
			t.Fatalf("Init: %v", err)
		}
		ci := fs.GetConfig(ctx)
		if ci.Transfers != 7 {
			t.Errorf("Transfers = %d, want the operator's 7", ci.Transfers)
		}
		if ci.LowLevelRetries != 99 {
			t.Errorf("LowLevelRetries = %d, want the operator's 99", ci.LowLevelRetries)
		}
		return
	}

	cmd := exec.Command(os.Args[0], "-test.run=TestInitLeavesEnvOverridesAlone", "-test.v")
	cmd.Env = append(os.Environ(),
		"GO_INIT_ENV_CHILD=1",
		"RCLONE_TRANSFERS=7",
		"RCLONE_LOW_LEVEL_RETRIES=99",
	)
	if out, err := cmd.CombinedOutput(); err != nil {
		t.Errorf("Init overrode the operator's environment:\n%s", out)
	}
}

// And with nothing set, the pikpak-derived tunables are what apply.
func TestInitAppliesTunablesWhenTheEnvIsQuiet(t *testing.T) {
	if os.Getenv("GO_INIT_QUIET_CHILD") == "1" {
		ctx, err := Init(t.Context(), Tunables{Transfers: 2, LowLevelRetries: 20})
		if err != nil {
			t.Fatalf("Init: %v", err)
		}
		ci := fs.GetConfig(ctx)
		if ci.Transfers != 2 || ci.LowLevelRetries != 20 {
			t.Errorf("Transfers=%d LowLevelRetries=%d, want 2 and 20",
				ci.Transfers, ci.LowLevelRetries)
		}
		return
	}

	cmd := exec.Command(os.Args[0], "-test.run=TestInitAppliesTunablesWhenTheEnvIsQuiet", "-test.v")
	cmd.Env = append(os.Environ(), "GO_INIT_QUIET_CHILD=1")
	// Cleared rather than assumed absent: the parent's own environment may
	// carry them, which would make this assert the opposite of what it says.
	cmd.Env = slices.DeleteFunc(cmd.Env, func(kv string) bool {
		return strings.HasPrefix(kv, "RCLONE_TRANSFERS=") ||
			strings.HasPrefix(kv, "RCLONE_LOW_LEVEL_RETRIES=")
	})
	if out, err := cmd.CombinedOutput(); err != nil {
		t.Errorf("Init did not apply its tunables:\n%s", out)
	}
}

// unset removes a variable for the duration of the test, restoring it after.
func unset(t *testing.T, key string) {
	t.Helper()
	if old, ok := os.LookupEnv(key); ok {
		t.Cleanup(func() { _ = os.Setenv(key, old) })
	}
	_ = os.Unsetenv(key)
}