Skip to content

Self-hosted, plugin-based server management.

3.1 KB
Raw Blame
import { describe, expect, it, vi } from "vitest";
import {
  isRetriableDnsError,
  pickSshAddress,
  resolveHostForSshConnect,
  resolveSshConnectConfigHost,
  shouldResolveBeforeSshConnect,
} from "../../hosts/ssh-dns.js";

describe("SSH DNS resolution", () => {
  it("retries transient EAI_AGAIN errors before returning an address", async () => {
    const lookup = vi
      .fn()
      .mockRejectedValueOnce(
        Object.assign(new Error("try again"), { code: "EAI_AGAIN" }),
      )
      .mockResolvedValueOnce({ address: "10.0.0.5", family: 4 });
    const wait = vi.fn().mockResolvedValue(undefined);

    await expect(
      resolveHostForSshConnect("alp", lookup, [10], wait),
    ).resolves.toEqual({
      host: "10.0.0.5",
      resolvedAddress: "10.0.0.5",
      attempts: 2,
    });
    expect(wait).toHaveBeenCalledWith(10);
  });

  it("does not retry permanent DNS failures", async () => {
    const error = Object.assign(new Error("not found"), { code: "ENOTFOUND" });
    const lookup = vi.fn().mockRejectedValue(error);
    const wait = vi.fn().mockResolvedValue(undefined);

    await expect(
      resolveHostForSshConnect("missing", lookup, [10], wait),
    ).rejects.toBe(error);
    expect(wait).not.toHaveBeenCalled();
  });

  it("skips DNS lookup for literal IP addresses", async () => {
    const lookup = vi.fn();

    await expect(
      resolveHostForSshConnect("192.0.2.1", lookup),
    ).resolves.toEqual({
      host: "192.0.2.1",
      attempts: 0,
    });
    expect(lookup).not.toHaveBeenCalled();
  });

  it("detects retryable DNS errors by code or message", () => {
    expect(isRetriableDnsError({ code: "EAI_AGAIN" })).toBe(true);
    expect(isRetriableDnsError(new Error("getaddrinfo EAI_AGAIN alp"))).toBe(
      true,
    );
    expect(isRetriableDnsError({ code: "ENOTFOUND" })).toBe(false);
  });

  it("only pre-resolves hostnames", () => {
    expect(shouldResolveBeforeSshConnect("alp")).toBe(true);
    expect(shouldResolveBeforeSshConnect("127.0.0.1")).toBe(false);
    expect(shouldResolveBeforeSshConnect("[2001:db8::1]")).toBe(false);
  });

  it("updates SSH connect config hosts in place", async () => {
    const lookup = vi
      .fn()
      .mockResolvedValue({ address: "10.0.0.6", family: 4 });
    const config = { host: "alp", port: 22 };

    await expect(resolveSshConnectConfigHost(config, lookup)).resolves.toEqual({
      host: "10.0.0.6",
      port: 22,
      originalHost: "alp",
      resolvedHost: "10.0.0.6",
    });
  });

  it("prefers an IPv4 address when a name has both", async () => {
    const lookup = vi.fn().mockResolvedValue([
      { address: "::1", family: 6 },
      { address: "10.0.0.7", family: 4 },
    ]);

    await expect(resolveHostForSshConnect("box", lookup)).resolves.toEqual({
      host: "10.0.0.7",
      resolvedAddress: "10.0.0.7",
      attempts: 1,
    });
    expect(lookup).toHaveBeenCalledWith("box", { all: true });
  });

  it("falls back to IPv6 when that is all there is", () => {
    expect(pickSshAddress([{ address: "2001:db8::2", family: 6 }])).toBe(
      "2001:db8::2",
    );
    expect(() => pickSshAddress([])).toThrow();
  });
});