Apply image bundle

//native

/**

 * Apply image bundle

 * Apply an EOS image bundle to a device (legacy Network Provisioning API, as cvprac does) and save, which creates the pending upgrade task returned in taskIds. The device is found by serial number, hostname, FQDN or system MAC address. Nothing runs on the switch until the task is executed, alone or in a change control.

 */

export async function main(

  auth: RT.AristaCloudvision,

  bundle_name: string,

  device: string

) {

  const bundle = await cv(

    auth,

    `/cvpservice/image/getImageBundleByName.do?name=${encodeURIComponent(bundle_name)}`,

    { notFound: `Image bundle ${bundle_name} not found` }

  )

  const dev = await findDevice(auth, device)

  const info = `Apply image: ${bundle_name} to netelement ${dev.fqdn}`

  await cv(

    auth,

    "/cvpservice/provisioning/addTempAction.do?format=topology&queryParam=&nodeId=root",

    {

      body: {

        data: [

          {

            info,

            infoPreview: info,

            note: "",

            action: "associate",

            nodeType: "imagebundle",

            nodeId: bundle.id ?? bundle.key,

            toId: dev.systemMacAddress,

            toIdType: "netelement",

            fromId: "",

            nodeName: bundle_name,

            fromName: "",

            toName: dev.fqdn,

            childTasks: [],

            parentTask: "",

          },

        ],

      },

    }

  )

  const saved = await cv(auth, "/cvpservice/provisioning/v2/saveTopology.do", {

    body: [],

  })

  return {

    status: saved.data?.status ?? "saved",

    taskIds: saved.data?.taskIds ?? [],

  }

}

async function findDevice(auth: RT.AristaCloudvision, target: string) {

  const devices = await cv(

    auth,

    "/cvpservice/inventory/devices?provisioned=true"

  )

  const t = target.toLowerCase()

  const device = (Array.isArray(devices) ? devices : []).find((d: any) =>

    [d.serialNumber, d.hostname, d.fqdn, d.systemMacAddress].some(

      (v) => typeof v === "string" && v.toLowerCase() === t

    )

  )

  if (!device) {

    throw new Error(

      `Device ${target} not found among the provisioned devices in CloudVision (match on serial number, hostname, FQDN or system MAC address)`

    )

  }

  return device

}

// Calls CloudVision and turns its failures into readable errors. Legacy

// endpoints report errors as HTTP 200 with an errorCode field.

async function cv(

  auth: RT.AristaCloudvision,

  path: string,

  options: { body?: unknown; notFound?: string; optional?: boolean } = {}

): Promise<any> {

  const url = new URL(path, auth.base_url)

  // cvprac sends legacy endpoints to /cvpservice on CVaaS and /web on

  // on-premises CVP. Its is_cvaas flag is the resource's deployment field;

  // when that is unset, a host under arista.io is taken as CVaaS.

  const cvaas = auth.deployment

    ? auth.deployment === "cvaas"

    : /(^|\.)arista\.io\.?$/i.test(url.hostname)

  if (!cvaas && url.pathname.startsWith("/cvpservice/")) {

    url.pathname = url.pathname.replace(/^\/cvpservice\//, "/web/")

  }

  const response = await fetch(url, {

    method: options.body === undefined ? "GET" : "POST",

    headers: {

      Authorization: `Bearer ${auth.token}`,

      ...(options.body === undefined

        ? {}

        : { "Content-Type": "application/json" }),

      Accept: "application/json",

    },

    body: options.body === undefined ? undefined : JSON.stringify(options.body),

  })

  const text = await response.text()

  if (

    response.status === 401 ||

    response.status === 403 ||

    (!response.ok && text.includes("User is unauthorized"))

  ) {

    throw new Error(

      `CloudVision refused the token (HTTP ${response.status}): check that the service-account token is valid, not expired, and that its role allows this call. ${text}`

    )

  }

  const data =

    text.trim() === ""

      ? {}

      : /^\s*[[{]/.test(text)

        ? JSON.parse(text)

        : undefined

  const error = findError(data)

  if (response.ok && data !== undefined && !error) return data

  const detail = error

    ? `${error.errorCode} ${error.errorMessage ?? (error.errors ?? []).join("; ")}`

    : `HTTP ${response.status} ${text.slice(0, 500)}`

  // Legacy lookups answer an unknown name or ID with an errorCode (cvprac

  // treats any error from getTaskById and getImageBundleByName that way).

  if (

    response.status === 404 ||

    (error && (options.optional || options.notFound))

  ) {

    if (options.optional) return undefined

    if (options.notFound) throw new Error(`${options.notFound} (${detail})`)

  }

  if (response.ok && !error) {

    throw new Error(

      `CloudVision returned a non-JSON response for ${url.pathname}: check that base_url is the CloudVision address. ${detail}`

    )

  }

  throw new Error(`CloudVision ${url.pathname} failed: ${detail}`)

}

function findError(value: any): any {

  if (!value || typeof value !== "object") return undefined

  // Like cvprac, only a truthy errorCode counts, at any depth.

  if (!Array.isArray(value) && value.errorCode) return value

  for (const item of Object.values(value)) {

    const error = findError(item)

    if (error) return error

  }

  return undefined

}