Class BuildContainer

This builder launches a one-off build container using Dockerode.

Hierarchy

BuildLocal
- BuildContainer

Constructors

constructor

new BuildContainer(opts?): BuildContainer
Parameters
- opts: Partial<{
      builder: string;
      caching: boolean;
      dockerImage: "ghcr.io/hackbg/fadroma:master";
      dockerSocket: "/var/run/docker.sock";
      dockerfile: string;
      noFetch: false;
      outputDir: string;
      outputGid: undefined | string;
      outputUid: undefined | string;
      podman: false;
      preferredRemote: undefined | string;
      quiet: false;
      raw: false;
      script: string;
      sshAuthSocket: undefined | string;
      toolchain: "";
      verbose: false;
      workspace: string;
  } & {
      docker?: Engine;
  }> = {}
Returns BuildContainer
Overrides BuildLocal.constructor
- Defined in fadroma-build.ts:146

Properties

`Optional` buildGid

buildGid?: number = ...

Owner gid that is set on build artifacts.

`Optional` buildUid

buildUid?: number = ...

Owner uid that is set on build artifacts.

caching

caching: boolean = true

Whether to enable build caching. When set to false, this builder will rebuild even when binary and checksum are both present in wasm/ directory

docker

docker: Engine

Used to launch build container.

dockerfile

dockerfile: string

Path to the dockerfile to build the build container if missing.

`Readonly` id

id: "Container" = 'Container'

Unique identifier of this builder implementation.

image

image: Image

Tag of the docker image for the build container.

log

log: BuildConsole = ...

Logger

noFetch

noFetch: boolean = false

Whether to skip any git fetch calls in the build script.

outputDir

outputDir: OpaqueDirectory

Name of directory where build artifacts are collected.

preferredRemote

preferredRemote: string = 'origin'

Used for historical builds.

quiet

quiet: boolean = false

Whether the build log should be printed only on error, or always

revision

revision: string = HEAD

Default Git reference from which to build sources.

`Optional` script

script?: string

The build script.

`Optional` sshAuthSocket

sshAuthSocket?: string

Used to authenticate Git in build container.

toolchain

toolchain: null | string = null

Version of Rust toolchain to use.

verbose

verbose: boolean = false

Whether the build process should print more detail to the console.

`Optional` workspace

workspace?: string

The project workspace.

`Static` variants

variants: Record<string, BuilderClass<Builder>> = {}

Global registry of builder variants. Populated downstream.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in fadroma-build.ts:173

Methods

build

build(contract): Promise<Built>
Build a single contract.
Parameters
- contract: Buildable
Returns Promise<Built>
Overrides BuildLocal.build
- Defined in fadroma-build.ts:177

`Protected` buildBatch

buildBatch(inputs, path, rev?): Promise<void>
Parameters
- inputs: Buildable[]
- path: string
- rev: string = HEAD
Returns Promise<void>
- Defined in fadroma-build.ts:218

`Protected` buildFailed

buildFailed(crates, code, logs): void
Parameters
- crates: string[]
- code: string | number
- logs: string
Returns void
- Defined in fadroma-build.ts:427

buildMany

buildMany(inputs): Promise<Built[]>
This implementation groups the passed source by workspace and ref, in order to launch one build container per workspace/ref combination and have it build all the crates from that combination in sequence, reusing the container's internal intermediate build cache.
Parameters
- inputs: (string | Buildable & Partial<Built>)[]
Returns Promise<Built[]>
Overrides BuildLocal.buildMany
- Defined in fadroma-build.ts:184

`Protected` collectBatches

collectBatches(inputs): Set<string>[]
Go over the list of inputs, filtering out the ones that are already built, and collecting the source repositories and revisions. This will allow for multiple crates from the same source checkout to be passed to a single build command.
Parameters
- inputs: Buildable[]
Returns Set<string>[]
- Defined in fadroma-build.ts:198

`Protected` collectCrates

collectCrates(outputDir, revision, crates): (Record<string, number> | (null | Built)[])[]
Parameters
- outputDir: string
- revision: string
- crates: [number, string][]
Returns (Record<string, number> | (null | Built)[])[]
- Defined in fadroma-build.ts:358

`Protected` fetch

fetch(gitDir, remote): Promise<void>
Parameters
- gitDir: Path
- remote: string
Returns Promise<void>
- Defined in fadroma-build.ts:278

`Protected` getEnv

getEnv(subdir, gitSubdir): Record<string, string>
Parameters
- subdir: string
- gitSubdir: string
Returns Record<string, string>
- Defined in fadroma-build.ts:385

`Protected` getLogStream

getLogStream(revision, cb): LineTransformStream
Parameters
- revision: string
- cb: ((data) => void)
  - - (data): void
    - Parameters
      
      data: string
      
      Returns void
Returns LineTransformStream
- Defined in fadroma-build.ts:412

`Protected` getMounts

getMounts(buildScript, root, outputDir, safeRef): {
readonly: Record<string, string>;
writable: Record<string, string>;
}
Parameters
- buildScript: string
- root: string
- outputDir: string
- safeRef: string
Returns {
readonly: Record<string, string>;
writable: Record<string, string>;
}
- readonly: Record<string, string>
- writable: Record<string, string>
- Defined in fadroma-build.ts:336

`Protected` getOptions

getOptions(subdir, gitSubdir, ro, rw): {
    cwd: string;
    env: Record<string, string>;
    extra: {
        AttachStdin: boolean;
        Tty: boolean;
    };
    readonly: Record<string, string>;
    remove: boolean;
    writable: Record<string, string>;
}
Parameters
- subdir: string
- gitSubdir: string
- ro: Record<string, string>
- rw: Record<string, string>
Returns {
    cwd: string;
    env: Record<string, string>;
    extra: {
        AttachStdin: boolean;
        Tty: boolean;
    };
    readonly: Record<string, string>;
    remove: boolean;
    writable: Record<string, string>;
}
- cwd: string
- env: Record<string, string>
- extra: {
  AttachStdin: boolean;
  Tty: boolean;
  }
  - AttachStdin: boolean
  - Tty: boolean
- readonly: Record<string, string>
- remove: boolean
- writable: Record<string, string>
- Defined in fadroma-build.ts:376

`Protected` getPathDependencies

getPathDependencies(input): Set<string>
Parameters
- input: Buildable
Returns Set<string>
- Defined in fadroma-build.ts:254

`Protected` getSrcSubDir

getSrcSubDir(paths, root): [Path, string]
Parameters
- paths: Set<string>
- root: Path
Returns [Path, string]
- Defined in fadroma-build.ts:262

`Protected` hashPath

hashPath(location): string
Parameters
- location: string | Path
Returns string
the SHA256 hash of the file at the specified location
Inherited from BuildLocal.hashPath
- Defined in fadroma-build.ts:103

`Protected` killBuildContainer

killBuildContainer(buildContainer): Promise<void>
Parameters
- buildContainer: Container
Returns Promise<void>
- Defined in fadroma-build.ts:440

`Protected` locationToContract

locationToContract(location): null | Contract<Client>
Parameters
- location: any
Returns null | Contract<Client>
- Defined in fadroma-build.ts:434

`Protected` matchBatch

matchBatch(inputs, path, rev): [number, string][]
Match each crate from the current repo/ref pair with its index in the originally passed list of inputs.
Parameters
- inputs: Buildable[]
- path: string
- rev: string
Returns [number, string][]
- Defined in fadroma-build.ts:283

`Protected` populatePrebuilt

populatePrebuilt(buildable): boolean
Parameters
- buildable: Buildable & Partial<Built>
Returns boolean
Inherited from BuildLocal.populatePrebuilt
- Defined in fadroma-build.ts:91

`Protected` prebuild

prebuild(outputDir, crate?, revision?): null | Built
Check if artifact exists in local artifacts cache directory. If it does, don't rebuild it but return it from there.
Parameters
- outputDir: string
- Optional crate: string
- revision: string = HEAD
Returns null | Built
Inherited from BuildLocal.prebuild
- Defined in fadroma-build.ts:80

`Protected` resolveSource

resolveSource(buildable): Buildable
Parameters
- buildable: string | Buildable
Returns Buildable
a fully populated Buildable from the original
Inherited from BuildLocal.resolveSource
- Defined in fadroma-build.ts:107

`Protected` runContainer

runContainer(root, subdir, rev, crates, gitSubDir?, outputDir?): Promise<(null | Built)[]>
Build the crates from each same workspace/revision pair and collect the results.
Parameters
- root: string
- subdir: string
- rev: string
- crates: [number, string][]
- gitSubDir: string = ''
- outputDir: string = ...
Returns Promise<(null | Built)[]>
- Defined in fadroma-build.ts:293

Class BuildContainer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BuildContainer

Properties

Optional buildGid

Optional buildUid

caching

docker

dockerfile

Readonly id

image

log

noFetch

outputDir

preferredRemote

quiet

revision

Optional script

Optional sshAuthSocket

toolchain

verbose

Optional workspace

Static variants

Accessors

[toStringTag]

Returns string

Methods

build

Parameters

contract: Buildable

Returns Promise<Built>

Protected buildBatch

Parameters

inputs: Buildable[]

path: string

rev: string = HEAD

Returns Promise<void>

Protected buildFailed

Parameters

crates: string[]

code: string | number

logs: string

Returns void

buildMany

Parameters

inputs: (string | Buildable & Partial<Built>)[]

Returns Promise<Built[]>

Protected collectBatches

Parameters

inputs: Buildable[]

Returns Set<string>[]

Protected collectCrates

Parameters

outputDir: string

revision: string

crates: [number, string][]

Returns (Record<string, number> | (null | Built)[])[]

Protected fetch

Parameters

gitDir: Path

remote: string

Returns Promise<void>

Protected getEnv

Parameters

subdir: string

gitSubdir: string

Returns Record<string, string>

Protected getLogStream

Parameters

revision: string

cb: ((data) => void)

Parameters

`Optional` buildGid

`Optional` buildUid

`Readonly` id

`Optional` script

`Optional` sshAuthSocket

`Optional` workspace

`Static` variants

`Protected` buildBatch

`Protected` buildFailed

`Protected` collectBatches

`Protected` collectCrates

`Protected` fetch

`Protected` getEnv

`Protected` getLogStream

`Protected` getMounts

Returns {
readonly: Record<string, string>;
writable: Record<string, string>;
}

`Protected` getOptions

Returns {
cwd: string;
env: Record<string, string>;
extra: {
AttachStdin: boolean;
Tty: boolean;
};
readonly: Record<string, string>;
remove: boolean;
writable: Record<string, string>;
}

extra: {
AttachStdin: boolean;
Tty: boolean;
}

`Protected` getPathDependencies

`Protected` getSrcSubDir

`Protected` hashPath

`Protected` killBuildContainer

`Protected` locationToContract

`Protected` matchBatch

`Protected` populatePrebuilt

`Protected` prebuild

`Optional` crate: string

`Protected` resolveSource

`Protected` runContainer