ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-01-18 02:39:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Stop creating an extra provisioning API key in each config generation

Browse Source 
Change-type: patch
Changelog-entry: Avoid creating an extra provisioning API key in os configure & config generate
See: https://github.com/balena-io/balena-cli/pull/2294#discussion_r756499196
Signed-off-by: Thodoris Greasidis <thodoris@balena.io>
This commit is contained in:
Thodoris Greasidis 2021-11-25 03:07:03 +02:00
parent fc0903a414
commit 58b29bf4bb
2 changed files with 23 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
lib/utils/config.ts
View File

@ -35,6 +35,9 @@ export interface ImgConfig {
wifiKey?: string; wifiKey?: string;
initialDeviceName?: string; initialDeviceName?: string;
apiKey?: string;
deviceApiKey?: string;
// props for older OS versions // props for older OS versions
connectivity?: string; connectivity?: string;
files?: { files?: {
@ -51,7 +54,7 @@ export interface ImgConfig {
}; };
} }
export async function generateBaseConfig( export async function generateApplicationConfig(
application: BalenaSdk.Application, application: BalenaSdk.Application,
options: { options: {
version: string; version: string;
@ -70,9 +73,7 @@ export async function generateBaseConfig(
const config = (await getBalenaSdk().models.os.getConfig( const config = (await getBalenaSdk().models.os.getConfig(
application.slug, application.slug,
options, options,
)) as ImgConfig & { apiKey?: string }; )) as ImgConfig;
// os.getConfig always returns a config for an app
delete config.apiKey;
// merge sshKeys to config, when they have been specified // merge sshKeys to config, when they have been specified
if (options.os && options.os.sshKeys) { if (options.os && options.os.sshKeys) {
@ -86,25 +87,6 @@ export async function generateBaseConfig(
return config; return config;
} }
export async function generateApplicationConfig(
application: BalenaSdk.Application,
options: {
version: string;
deviceType?: string;
appUpdatePollInterval?: number;
},
) {
const config = await generateBaseConfig(application, options);
if (semver.satisfies(options.version, '<2.7.8')) {
await addApplicationKey(config, application.id);
} else {
await addProvisioningKey(config, application.id);
}
return config;
}
export function generateDeviceConfig( export function generateDeviceConfig(
device: DeviceWithDeviceType & { device: DeviceWithDeviceType & {
belongs_to__application: BalenaSdk.PineDeferred; belongs_to__application: BalenaSdk.PineDeferred;
@ -112,19 +94,32 @@ export function generateDeviceConfig(
deviceApiKey: string | true | undefined, deviceApiKey: string | true | undefined,
options: { version: string }, options: { version: string },
) { ) {
return getBalenaSdk() const sdk = getBalenaSdk();
.models.application.get(device.belongs_to__application.__id) return sdk.models.application
.get(device.belongs_to__application.__id)
.then(async (application) => { .then(async (application) => {
const baseConfigOpts = { const baseConfigOpts = {
...options, ...options,
deviceType: device.is_of__device_type[0].slug, deviceType: device.is_of__device_type[0].slug,
}; };
const config = await generateBaseConfig(application, baseConfigOpts); // TODO: Generate the correct key beforehand and pass it to os.getConfig() once
// the API supports injecting a provided key, to avoid generating an unused one.
const config = await generateApplicationConfig(
application,
baseConfigOpts,
);
// os.getConfig always returns a config for an app
delete config.apiKey;
if (deviceApiKey == null && semver.satisfies(options.version, '<2.0.3')) { if (deviceApiKey == null && semver.satisfies(options.version, '<2.0.3')) {
await addApplicationKey(config, application.id); config.apiKey = await sdk.models.application.generateApiKey(
application.id,
);
} else { } else {
await addDeviceKey(config, device.uuid, deviceApiKey || true); config.deviceApiKey =
typeof deviceApiKey === 'string' && deviceApiKey
? deviceApiKey
: await sdk.models.device.generateDeviceKey(device.uuid);
} }
return config; return config;
@ -139,35 +134,3 @@ export function generateDeviceConfig(
return config; return config;
}); });
} }
function addApplicationKey(config: any, applicationNameOrId: string | number) {
return getBalenaSdk()
.models.application.generateApiKey(applicationNameOrId)
.then((apiKey) => {
config.apiKey = apiKey;
return apiKey;
});
}
function addProvisioningKey(config: any, applicationNameOrId: string | number) {
return getBalenaSdk()
.models.application.generateProvisioningKey(applicationNameOrId)
.then((apiKey) => {
config.apiKey = apiKey;
return apiKey;
});
}
async function addDeviceKey(
config: any,
uuid: string,
customDeviceApiKey: string | true,
) {
if (customDeviceApiKey === true) {
config.deviceApiKey = await getBalenaSdk().models.device.generateDeviceKey(
uuid,
);
} else {
config.deviceApiKey = customDeviceApiKey;
}
}

1
tests/commands/os/configure.spec.ts
View File

@ -49,7 +49,6 @@ if (process.platform !== 'win32') {
api.expectGetApplication(); api.expectGetApplication();
api.expectGetConfigDeviceTypes(); api.expectGetConfigDeviceTypes();
api.expectDownloadConfig(); api.expectDownloadConfig();
api.expectApplicationProvisioning();
const command: string[] = [ const command: string[] = [
`os configure ${tmpPath}`, `os configure ${tmpPath}`,