-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
oci: loadArchive to import an index from a tar archive image bundle
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
- Loading branch information
Showing
22 changed files
with
685 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
/.yarn/releases/** binary | ||
/.yarn/plugins/** binary | ||
/__tests__/fixtures/oci-archive/** binary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+4.35 KB
__tests__/fixtures/oci-archive/docker~test-docker-action~COIO50.dockerbuild
Binary file not shown.
Binary file added
BIN
+7.79 KB
__tests__/fixtures/oci-archive/docker~test-docker-action~SNHBPN+3.dockerbuild
Binary file not shown.
Binary file added
BIN
+56.1 KB
__tests__/fixtures/oci-archive/docker~test-docker-action~TYO4JJ+15.dockerbuild
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/** | ||
* Copyright 2024 actions-toolkit authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import {afterEach, beforeEach, describe, expect, jest, test} from '@jest/globals'; | ||
import path from 'path'; | ||
import * as rimraf from 'rimraf'; | ||
|
||
import {OCI} from '../../src/oci/oci'; | ||
|
||
const fixturesDir = path.join(__dirname, '..', 'fixtures'); | ||
|
||
// prettier-ignore | ||
const tmpDir = path.join(process.env.TEMP || '/tmp', 'docker-jest'); | ||
|
||
beforeEach(() => { | ||
jest.clearAllMocks(); | ||
}); | ||
|
||
afterEach(function () { | ||
rimraf.sync(tmpDir); | ||
}); | ||
|
||
describe('loadArchive', () => { | ||
// prettier-ignore | ||
test.each([ | ||
['docker~test-docker-action~COIO50.dockerbuild'], | ||
['docker~test-docker-action~SNHBPN+3.dockerbuild'], | ||
['docker~test-docker-action~TYO4JJ+15.dockerbuild'], | ||
['hello-oci-gzip.tar'], | ||
['hello-oci-multiplatform-gzip.tar'], | ||
['hello-oci-uncompressed.tar'], | ||
['hello-oci-zstd.tar'] | ||
])('extracting %p', async (filename) => { | ||
const res = await OCI.loadArchive({ | ||
file: path.join(fixturesDir, 'oci-archive', filename) | ||
}); | ||
expect(res).toBeDefined(); | ||
expect(res?.root.index).toBeDefined(); | ||
expect(res?.root.layout).toBeDefined(); | ||
// console.log(JSON.stringify(res, null, 2)); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,197 @@ | ||
/** | ||
* Copyright 2024 actions-toolkit authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import fs from 'fs'; | ||
import gunzip from 'gunzip-maybe'; | ||
import * as path from 'path'; | ||
import {PassThrough, Readable} from 'stream'; | ||
import * as tar from 'tar-stream'; | ||
|
||
import {Archive, LoadArchiveOpts} from '../types/oci/oci'; | ||
import {Index} from '../types/oci'; | ||
import {Manifest} from '../types/oci/manifest'; | ||
import {Image} from '../types/oci/config'; | ||
import {IMAGE_BLOBS_DIR_V1, IMAGE_INDEX_FILE_V1, IMAGE_LAYOUT_FILE_V1, ImageLayout} from '../types/oci/layout'; | ||
import {MEDIATYPE_IMAGE_INDEX_V1, MEDIATYPE_IMAGE_MANIFEST_V1} from '../types/oci/mediatype'; | ||
|
||
export class OCI { | ||
public static loadArchive(opts: LoadArchiveOpts): Promise<Archive> { | ||
return new Promise<Archive>((resolve, reject) => { | ||
const tarex: tar.Extract = tar.extract(); | ||
|
||
let rootIndex: Index; | ||
let rootLayout: ImageLayout; | ||
const indexes: Record<string, Index> = {}; | ||
const manifests: Record<string, Manifest> = {}; | ||
const images: Record<string, Image> = {}; | ||
const blobs: Record<string, unknown> = {}; | ||
|
||
tarex.on('entry', async (header, stream, next) => { | ||
if (header.type === 'file') { | ||
const filename = path.normalize(header.name); | ||
if (filename === IMAGE_INDEX_FILE_V1) { | ||
rootIndex = await OCI.streamToJson<Index>(stream); | ||
} else if (filename === IMAGE_LAYOUT_FILE_V1) { | ||
rootLayout = await OCI.streamToJson<ImageLayout>(stream); | ||
} else if (filename.startsWith(path.join(IMAGE_BLOBS_DIR_V1, path.sep))) { | ||
const blob = await OCI.extractBlob(stream); | ||
const digest = `${filename.split(path.sep)[1]}:${filename.split(path.sep)[filename.split(path.sep).length - 1]}`; | ||
if (OCI.isIndex(blob)) { | ||
indexes[digest] = <Index>JSON.parse(blob); | ||
} else if (OCI.isManifest(blob)) { | ||
manifests[digest] = <Manifest>JSON.parse(blob); | ||
} else if (OCI.isImage(blob)) { | ||
images[digest] = <Image>JSON.parse(blob); | ||
} else { | ||
blobs[digest] = blob; | ||
} | ||
} else { | ||
reject(new Error(`Invalid OCI archive: unexpected file ${filename}`)); | ||
} | ||
} | ||
stream.resume(); | ||
next(); | ||
}); | ||
|
||
tarex.on('finish', () => { | ||
if (!rootIndex || !rootLayout) { | ||
reject(new Error('Invalid OCI archive: missing index or layout')); | ||
} | ||
resolve({ | ||
root: { | ||
index: rootIndex, | ||
layout: rootLayout | ||
}, | ||
indexes: indexes, | ||
manifests: manifests, | ||
images: images, | ||
blobs: blobs | ||
} as Archive); | ||
}); | ||
|
||
tarex.on('error', error => { | ||
reject(error); | ||
}); | ||
|
||
fs.createReadStream(opts.file).pipe(gunzip()).pipe(tarex); | ||
}); | ||
} | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
private static isIndex(blob: any): boolean { | ||
try { | ||
const index = <Index>JSON.parse(blob); | ||
return index.mediaType === MEDIATYPE_IMAGE_INDEX_V1; | ||
} catch { | ||
return false; | ||
} | ||
} | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
private static isManifest(blob: any): boolean { | ||
try { | ||
const manifest = <Manifest>JSON.parse(blob); | ||
return manifest.mediaType === MEDIATYPE_IMAGE_MANIFEST_V1 && manifest.layers.length > 0; | ||
} catch { | ||
return false; | ||
} | ||
} | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
private static isImage(blob: any): boolean { | ||
try { | ||
const image = <Image>JSON.parse(blob); | ||
return image.rootfs.type !== ''; | ||
} catch { | ||
return false; | ||
} | ||
} | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
private static async extractBlob(stream: Readable): Promise<any> { | ||
const tarStream = new PassThrough(); | ||
const stringStream = new PassThrough(); | ||
const teeStream = new PassThrough(); | ||
stream.pipe(teeStream); | ||
teeStream.pipe(tarStream); | ||
teeStream.pipe(stringStream); | ||
const promises = [OCI.extractTar(tarStream).catch(() => undefined), OCI.streamToString(stringStream).catch(() => undefined)]; | ||
const [blobTar, blobString] = await Promise.all(promises); | ||
return blobTar ?? blobString; | ||
} | ||
|
||
private static async extractTar(stream: Readable): Promise<unknown> { | ||
let dt: unknown; | ||
return new Promise<unknown>((resolve, reject) => { | ||
const tarex: tar.Extract = tar.extract(); | ||
tarex.on('entry', async (header, stream, next) => { | ||
if (header.type === 'file') { | ||
const streamCopy = new PassThrough(); | ||
stream.pipe(streamCopy); | ||
dt = await OCI.streamToString(streamCopy); | ||
} | ||
stream.resume(); | ||
next(); | ||
}); | ||
tarex.on('finish', () => { | ||
resolve(dt); | ||
}); | ||
tarex.on('error', async error => { | ||
reject(error); | ||
}); | ||
stream.pipe(gunzip()).pipe(tarex); | ||
}); | ||
} | ||
|
||
private static async streamToJson<T>(stream: Readable): Promise<T> { | ||
return new Promise<T>((resolve, reject) => { | ||
const chunks: string[] = []; | ||
let bytes = 0; | ||
stream.on('data', chunk => { | ||
bytes += chunk.length; | ||
if (bytes <= 2 * 1024 * 1024) { | ||
chunks.push(chunk.toString('utf8')); | ||
} else { | ||
reject(new Error('The data stream exceeds the size limit for JSON parsing.')); | ||
} | ||
}); | ||
stream.on('end', () => { | ||
try { | ||
resolve(JSON.parse(chunks.join(''))); | ||
} catch (error) { | ||
reject(error); | ||
} | ||
}); | ||
stream.on('error', async error => { | ||
reject(error); | ||
}); | ||
}); | ||
} | ||
|
||
private static async streamToString(stream: Readable): Promise<string> { | ||
const chunks: Buffer[] = []; | ||
return new Promise((resolve, reject) => { | ||
stream.on('data', chunk => { | ||
chunks.push(chunk); | ||
}); | ||
stream.on('end', () => { | ||
resolve(Buffer.concat(chunks).toString('utf8')); | ||
}); | ||
stream.on('error', async error => { | ||
reject(error); | ||
}); | ||
}); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/** | ||
* Copyright 2024 actions-toolkit authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import {Digest} from './digest'; | ||
import {Platform} from './descriptor'; | ||
|
||
export interface ImageConfig { | ||
User?: string; | ||
ExposedPorts?: Record<string, unknown>; | ||
Env?: string[]; | ||
Entrypoint?: string[]; | ||
Cmd?: string[]; | ||
Volumes?: Record<string, unknown>; | ||
WorkingDir?: string; | ||
Labels?: Record<string, string>; | ||
StopSignal?: string; | ||
ArgsEscaped?: boolean; | ||
} | ||
|
||
export interface RootFS { | ||
type: string; | ||
diff_ids: Digest[]; | ||
} | ||
|
||
export interface History { | ||
created?: string; // assuming RFC 3339 formatted string | ||
created_by?: string; | ||
author?: string; | ||
comment?: string; | ||
empty_layer?: boolean; | ||
} | ||
|
||
export interface Image extends Platform { | ||
created?: string; // assuming RFC 3339 formatted string | ||
author?: string; | ||
config?: ImageConfig; | ||
rootfs: RootFS; | ||
history?: History[]; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
/** | ||
* Copyright 2024 actions-toolkit authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import {Digest} from './digest'; | ||
|
||
import {MEDIATYPE_EMPTY_JSON_V1} from './mediatype'; | ||
|
||
export interface Descriptor { | ||
mediaType: string; | ||
digest: Digest; | ||
size: number; | ||
urls?: string[]; | ||
annotations?: Record<string, string>; | ||
data?: string; | ||
platform?: Platform; | ||
artifactType?: string; | ||
} | ||
|
||
export interface Platform { | ||
architecture: string; | ||
os: string; | ||
'os.version'?: string; | ||
'os.features'?: string[]; | ||
variant?: string; | ||
} | ||
|
||
export const DescriptorEmptyJSON: Descriptor = { | ||
mediaType: MEDIATYPE_EMPTY_JSON_V1, | ||
digest: 'sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a', | ||
size: 2, | ||
data: '{}' | ||
}; |
Oops, something went wrong.