mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-21 22:47:48 +00:00
547 lines
18 KiB
TypeScript
547 lines
18 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Balena Ltd.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
// tslint:disable-next-line:no-var-requires
|
|
require('../config-tests'); // required for side effects
|
|
|
|
import { expect } from 'chai';
|
|
import { fs } from 'mz';
|
|
import * as path from 'path';
|
|
|
|
import { isV12 } from '../../build/utils/version';
|
|
import { BalenaAPIMock } from '../balena-api-mock';
|
|
import { BuilderMock, builderResponsePath } from '../builder-mock';
|
|
import { expectStreamNoCRLF, testPushBuildStream } from '../docker-build';
|
|
import { cleanOutput, runCommand } from '../helpers';
|
|
import {
|
|
addRegSecretsEntries,
|
|
ExpectedTarStreamFiles,
|
|
setupDockerignoreTestData,
|
|
} from '../projects';
|
|
|
|
const repoPath = path.normalize(path.join(__dirname, '..', '..'));
|
|
const projectsPath = path.join(repoPath, 'tests', 'test-data', 'projects');
|
|
|
|
const commonResponseLines = {
|
|
'build-POST-v3.json': [
|
|
'[Info] Starting build for testApp, user gh_user',
|
|
'[Info] Dashboard link: https://dashboard.balena-cloud.com/apps/1301645/devices',
|
|
'[Info] Building on arm01',
|
|
'[Info] Pulling previous images for caching purposes...',
|
|
'[Success] Successfully pulled cache images',
|
|
'[main] Step 1/4 : FROM busybox',
|
|
'[main] ---> 76aea0766768',
|
|
'[main] Step 2/4 : COPY ./src/start.sh /start.sh',
|
|
'[main] ---> b563ad6a0801',
|
|
'[main] Step 3/4 : RUN chmod a+x /start.sh',
|
|
'[main] ---> Running in 10d4ddc40bfc',
|
|
'[main] Removing intermediate container 10d4ddc40bfc',
|
|
'[main] ---> 82e98871a32c',
|
|
'[main] Step 4/4 : CMD ["/start.sh"]',
|
|
'[main] ---> Running in 0682894e13eb',
|
|
'[main] Removing intermediate container 0682894e13eb',
|
|
'[main] ---> 889ccb6afc7c',
|
|
'[main] Successfully built 889ccb6afc7c',
|
|
'[Info] Uploading images',
|
|
'[Success] Successfully uploaded images',
|
|
'[Info] Built on arm01',
|
|
'[Success] Release successfully created!',
|
|
'[Info] Release: 05a24b5b034c9f95f25d4d74f0593bea (id: 1220245)',
|
|
'[Info] ┌─────────┬────────────┬────────────┐',
|
|
'[Info] │ Service │ Image Size │ Build Time │',
|
|
'[Info] ├─────────┼────────────┼────────────┤',
|
|
'[Info] │ main │ 1.32 MB │ 11 seconds │',
|
|
'[Info] └─────────┴────────────┴────────────┘',
|
|
],
|
|
};
|
|
|
|
const commonQueryParams = [
|
|
['owner', 'bob'],
|
|
['app', 'testApp'],
|
|
['dockerfilePath', ''],
|
|
['emulated', 'false'],
|
|
['nocache', 'false'],
|
|
['headless', 'false'],
|
|
];
|
|
|
|
const itSkipWindows = process.platform === 'win32' ? it.skip : it;
|
|
|
|
describe('balena push', function() {
|
|
let api: BalenaAPIMock;
|
|
let builder: BuilderMock;
|
|
const isWindows = process.platform === 'win32';
|
|
|
|
this.beforeEach(() => {
|
|
api = new BalenaAPIMock();
|
|
builder = new BuilderMock();
|
|
api.expectGetWhoAmI({ optional: true, persist: true });
|
|
api.expectGetMixpanel({ optional: true });
|
|
api.expectGetMyApplication();
|
|
});
|
|
|
|
this.afterEach(() => {
|
|
// Check all expected api calls have been made and clean up.
|
|
api.done();
|
|
builder.done();
|
|
});
|
|
|
|
this.beforeAll(async () => {
|
|
await setupDockerignoreTestData();
|
|
});
|
|
|
|
this.afterAll(async () => {
|
|
await setupDockerignoreTestData({ cleanup: true });
|
|
});
|
|
|
|
it('should create the expected tar stream (single container)', async () => {
|
|
const projectPath = path.join(projectsPath, 'no-docker-compose', 'basic');
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'src/start.sh': { fileSize: 89, type: 'file' },
|
|
'src/windows-crlf.sh': { fileSize: 70, type: 'file' },
|
|
Dockerfile: { fileSize: 88, type: 'file' },
|
|
'Dockerfile-alt': { fileSize: 30, type: 'file' },
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedResponseLines = [...commonResponseLines[responseFilename]];
|
|
if (isWindows) {
|
|
expectedResponseLines.push(
|
|
`[Warn] CRLF (Windows) line endings detected in file: ${path.join(
|
|
projectPath,
|
|
'src',
|
|
'windows-crlf.sh',
|
|
)}`,
|
|
'[Warn] Windows-format line endings were detected in some files. Consider using the `--convert-eol` option.',
|
|
);
|
|
}
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp --source ${projectPath} -R ${regSecretsPath} -G`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines,
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
it('should create the expected tar stream (alternative Dockerfile)', async () => {
|
|
const projectPath = path.join(projectsPath, 'no-docker-compose', 'basic');
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'src/start.sh': { fileSize: 89, type: 'file' },
|
|
'src/windows-crlf.sh': { fileSize: 70, type: 'file' },
|
|
Dockerfile: { fileSize: 88, type: 'file' },
|
|
'Dockerfile-alt': { fileSize: 30, type: 'file' },
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedQueryParams = commonQueryParams.map(i =>
|
|
i[0] === 'dockerfilePath' ? ['dockerfilePath', 'Dockerfile-alt'] : i,
|
|
);
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} --dockerfile Dockerfile-alt --nogitignore`,
|
|
expectedFiles,
|
|
expectedQueryParams,
|
|
expectedResponseLines: commonResponseLines[responseFilename],
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
it('should create the expected tar stream (single container, --convert-eol)', async () => {
|
|
const projectPath = path.join(projectsPath, 'no-docker-compose', 'basic');
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'src/start.sh': { fileSize: 89, type: 'file' },
|
|
'src/windows-crlf.sh': {
|
|
fileSize: isWindows ? 68 : 70,
|
|
type: 'file',
|
|
testStream: isWindows ? expectStreamNoCRLF : undefined,
|
|
},
|
|
Dockerfile: { fileSize: 88, type: 'file' },
|
|
'Dockerfile-alt': { fileSize: 30, type: 'file' },
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedResponseLines = [...commonResponseLines[responseFilename]];
|
|
if (isWindows) {
|
|
expectedResponseLines.push(
|
|
`[Info] Converting line endings CRLF -> LF for file: ${path.join(
|
|
projectPath,
|
|
'src',
|
|
'windows-crlf.sh',
|
|
)}`,
|
|
);
|
|
}
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines,
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
// Skip Windows because the old tarDirectory() implementation (still used when
|
|
// '--nogitignore' is not provided) uses the old `zeit/dockerignore` npm package
|
|
// that is broken on Windows (reason why we created `@balena/dockerignore`).
|
|
itSkipWindows(
|
|
'should create the expected tar stream (single container, with gitignore)',
|
|
async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'no-docker-compose',
|
|
'dockerignore1',
|
|
);
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'.balena/balena.yml': { fileSize: 12, type: 'file' },
|
|
'.dockerignore': { fileSize: 438, type: 'file' },
|
|
'.gitignore': { fileSize: 20, type: 'file' },
|
|
'.git/foo.txt': { fileSize: 4, type: 'file' },
|
|
'c.txt': { fileSize: 1, type: 'file' },
|
|
Dockerfile: { fileSize: 13, type: 'file' },
|
|
'src/.balena/balena.yml': { fileSize: 16, type: 'file' },
|
|
'src/.gitignore': { fileSize: 10, type: 'file' },
|
|
'vendor/.git/vendor-git-contents': { fileSize: 20, type: 'file' },
|
|
...(isV12()
|
|
? {
|
|
'a.txt': { fileSize: 1, type: 'file' },
|
|
'src/src-a.txt': { fileSize: 5, type: 'file' },
|
|
'src/src-c.txt': { fileSize: 5, type: 'file' },
|
|
}
|
|
: {
|
|
'.git/bar.txt': { fileSize: 4, type: 'file' },
|
|
}),
|
|
};
|
|
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedResponseLines = [
|
|
...(!isV12()
|
|
? [
|
|
'[Warn] Using file ignore patterns from:',
|
|
`[Warn] ${path.join(projectPath, '.dockerignore')}`,
|
|
`[Warn] ${path.join(projectPath, '.gitignore')}`,
|
|
`[Warn] ${path.join(projectPath, 'src', '.gitignore')}`,
|
|
'[Warn] balena CLI currently uses gitgnore and dockerignore files, but an upcoming major',
|
|
'[Warn] version release will disregard gitignore files and use a dockerignore file only.',
|
|
'[Warn] Use the --nogitignore (-G) option to enable the new behavior already now and',
|
|
"[Warn] suppress this warning. For more information, see 'balena help push'.",
|
|
]
|
|
: []),
|
|
...commonResponseLines[responseFilename],
|
|
];
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines,
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
},
|
|
);
|
|
|
|
it('should create the expected tar stream (single container, --nogitignore)', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'no-docker-compose',
|
|
'dockerignore1',
|
|
);
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'.balena/balena.yml': { fileSize: 12, type: 'file' },
|
|
'.dockerignore': { fileSize: 438, type: 'file' },
|
|
'.gitignore': { fileSize: 20, type: 'file' },
|
|
'.git/foo.txt': { fileSize: 4, type: 'file' },
|
|
'a.txt': { fileSize: 1, type: 'file' },
|
|
'c.txt': { fileSize: 1, type: 'file' },
|
|
Dockerfile: { fileSize: 13, type: 'file' },
|
|
'src/.balena/balena.yml': { fileSize: 16, type: 'file' },
|
|
'src/.gitignore': { fileSize: 10, type: 'file' },
|
|
'src/src-a.txt': { fileSize: 5, type: 'file' },
|
|
'src/src-c.txt': { fileSize: 5, type: 'file' },
|
|
'vendor/.git/vendor-git-contents': { fileSize: 20, type: 'file' },
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l -G`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines: commonResponseLines[responseFilename],
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
it('should create the expected tar stream (single container, symbolic links, --nogitignore)', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'no-docker-compose',
|
|
'dockerignore2',
|
|
);
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'.dockerignore': { fileSize: 34, type: 'file' },
|
|
'b.txt': { fileSize: 1, type: 'file' },
|
|
Dockerfile: { fileSize: 13, type: 'file' },
|
|
'src/src-b.txt': { fileSize: 5, type: 'file' },
|
|
'symlink-a.txt': { fileSize: 5, type: 'file' },
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l -G`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines: commonResponseLines[responseFilename],
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
it('should create the expected tar stream (single container, dockerignore warn)', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'no-docker-compose',
|
|
'dockerignore2',
|
|
);
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'.dockerignore': { fileSize: 34, type: 'file' },
|
|
'b.txt': { fileSize: 1, type: 'file' },
|
|
Dockerfile: { fileSize: 13, type: 'file' },
|
|
'src/src-b.txt': { fileSize: 5, type: 'file' },
|
|
'symlink-a.txt': { fileSize: 5, type: 'file' },
|
|
};
|
|
if (isWindows) {
|
|
// this test uses the old tarDirectory implementation, which uses
|
|
// the zeit/dockerignore library that has bugs on Windows
|
|
expectedFiles['src/src-a.txt'] = { fileSize: 5, type: 'file' };
|
|
}
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedResponseLines = isWindows
|
|
? [
|
|
'[Warn] Using file ignore patterns from:',
|
|
`[Warn] ${path.join(projectPath, '.dockerignore')}`,
|
|
'[Warn] Use the --nogitignore (-G) option to suppress this warning and enable the use',
|
|
'[Warn] of a better dockerignore parser and filter library that fixes several issues',
|
|
'[Warn] on Windows and improves compatibility with "docker build", but which may also',
|
|
'[Warn] cause a different set of files to be filtered out (because of the bug fixes).',
|
|
'[Warn] The --nogitignore option will be the default behavior in an upcoming balena CLI',
|
|
"[Warn] major version release. For more information, see 'balena help push'.",
|
|
...commonResponseLines[responseFilename],
|
|
]
|
|
: commonResponseLines[responseFilename];
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines,
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
|
|
it('should create the expected tar stream (docker-compose)', async () => {
|
|
const projectPath = path.join(projectsPath, 'docker-compose', 'basic');
|
|
const expectedFiles: ExpectedTarStreamFiles = {
|
|
'.balena/balena.yml': { fileSize: 197, type: 'file' },
|
|
'.dockerignore': { fileSize: 22, type: 'file' },
|
|
'docker-compose.yml': { fileSize: 245, type: 'file' },
|
|
'service1/Dockerfile.template': { fileSize: 144, type: 'file' },
|
|
'service1/file1.sh': { fileSize: 12, type: 'file' },
|
|
'service2/Dockerfile-alt': { fileSize: 40, type: 'file' },
|
|
'service2/file2-crlf.sh': {
|
|
fileSize: isWindows ? 12 : 14,
|
|
testStream: isWindows ? expectStreamNoCRLF : undefined,
|
|
type: 'file',
|
|
},
|
|
};
|
|
const regSecretsPath = await addRegSecretsEntries(expectedFiles);
|
|
const responseFilename = 'build-POST-v3.json';
|
|
const responseBody = await fs.readFile(
|
|
path.join(builderResponsePath, responseFilename),
|
|
'utf8',
|
|
);
|
|
const expectedResponseLines: string[] = [
|
|
...commonResponseLines[responseFilename],
|
|
];
|
|
if (isWindows) {
|
|
expectedResponseLines.push(
|
|
`[Info] Converting line endings CRLF -> LF for file: ${path.join(
|
|
projectPath,
|
|
'service2',
|
|
'file2-crlf.sh',
|
|
)}`,
|
|
);
|
|
}
|
|
|
|
await testPushBuildStream({
|
|
builderMock: builder,
|
|
commandLine: `push testApp -s ${projectPath} -R ${regSecretsPath} -l -G`,
|
|
expectedFiles,
|
|
expectedQueryParams: commonQueryParams,
|
|
expectedResponseLines,
|
|
projectPath,
|
|
responseBody,
|
|
responseCode: 200,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('balena push: project validation', function() {
|
|
it('should raise ExpectedError if the project folder is not a directory', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'docker-compose',
|
|
'basic',
|
|
'docker-compose.yml',
|
|
);
|
|
const expectedErrorLines = [
|
|
`Could not access source folder: "${projectPath}"`,
|
|
];
|
|
|
|
const { out, err } = await runCommand(
|
|
`push testApp --source ${projectPath} --nogitignore`,
|
|
);
|
|
expect(
|
|
cleanOutput(err).map(line => line.replace(/\s{2,}/g, ' ')),
|
|
).to.include.members(expectedErrorLines);
|
|
expect(out).to.be.empty;
|
|
});
|
|
|
|
it('should raise ExpectedError if a Dockerfile cannot be found', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'docker-compose',
|
|
'basic',
|
|
'service2',
|
|
);
|
|
const expectedErrorLines = [
|
|
'Error: no "Dockerfile[.*]", "docker-compose.yml" or "package.json" file',
|
|
`found in source folder "${projectPath}"`,
|
|
];
|
|
|
|
const { out, err } = await runCommand(
|
|
`push testApp --source ${projectPath}`,
|
|
);
|
|
expect(
|
|
cleanOutput(err).map(line => line.replace(/\s{2,}/g, ' ')),
|
|
).to.include.members(expectedErrorLines);
|
|
expect(out).to.be.empty;
|
|
});
|
|
|
|
it('should log a warning if a docker-compose.yml exists in a parent folder', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'docker-compose',
|
|
'basic',
|
|
'service1',
|
|
);
|
|
const expectedErrorLines = isV12()
|
|
? [
|
|
'Error: "docker-compose.y[a]ml" file found in parent directory: please check that',
|
|
"the correct source folder was specified. (Suppress with '--noparent-check'.)",
|
|
]
|
|
: ['The --nolive flag is only valid when pushing to a local mode device'];
|
|
const expectedOutputLines = isV12()
|
|
? []
|
|
: [
|
|
'[Warn] "docker-compose.y[a]ml" file found in parent directory: please check that',
|
|
"[Warn] the correct source folder was specified. (Suppress with '--noparent-check'.)",
|
|
];
|
|
|
|
const { out, err } = await runCommand(
|
|
`push testApp --source ${projectPath} --nolive`,
|
|
);
|
|
expect(
|
|
cleanOutput(err).map(line => line.replace(/\s{2,}/g, ' ')),
|
|
).to.include.members(expectedErrorLines);
|
|
expect(
|
|
cleanOutput(out).map(line => line.replace(/\s{2,}/g, ' ')),
|
|
).to.include.members(expectedOutputLines);
|
|
});
|
|
|
|
it('should suppress a parent folder check with --noparent-check', async () => {
|
|
const projectPath = path.join(
|
|
projectsPath,
|
|
'docker-compose',
|
|
'basic',
|
|
'service1',
|
|
);
|
|
const expectedErrorLines = [
|
|
'The --nolive flag is only valid when pushing to a local mode device',
|
|
];
|
|
|
|
const { out, err } = await runCommand(
|
|
`push testApp --source ${projectPath} --nolive --noparent-check`,
|
|
);
|
|
expect(
|
|
cleanOutput(err).map(line => line.replace(/\s{2,}/g, ' ')),
|
|
).to.include.members(expectedErrorLines);
|
|
expect(out).to.be.empty;
|
|
});
|
|
});
|