ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-01-29 15:44:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

config write: Fix parsing of 'key' argument with numeric components

Browse Source 
Change-type: patch
This commit is contained in:
Paulo Castro 2021-07-09 00:23:46 +01:00
parent fe7cbf4f74
commit 36f4c1312b
2 changed files with 82 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/commands/config/write.ts
View File

@ -85,8 +85,7 @@ export default class ConfigWriteCmd extends Command {
const configJSON = await config.read(drive, options.type);
console.info(`Setting ${params.key} to ${params.value}`);
const _ = await import('lodash');
_.set(configJSON, params.key, params.value);
ConfigWriteCmd.updateConfigJson(configJSON, params.key, params.value);
await safeUmount(drive);
@ -94,4 +93,14 @@ export default class ConfigWriteCmd extends Command {
console.info('Done');
}
/** Call Lodash's _.setWith(). Moved here for ease of testing. */
static updateConfigJson(configJSON: object, key: string, value: string) {
const _ = require('lodash') as typeof import('lodash');
// note: _.setWith() is needed instead of _.set() because, given a key
// like `os.udevRules.101`, _.set() creates a udevRules array (rather
// than a dictionary) and sets the 101st array element to value, while
// we actually want udevRules to be dictionary like { '101': value }
_.setWith(configJSON, key, value, (v) => v || {});
}
}

71
tests/commands/config/write.spec.ts Normal file
View File

@ -0,0 +1,71 @@
/**
* @license
* Copyright 2021 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.
*/
import { expect } from 'chai';
import ConfigWriteCmd from '../../../build/commands/config/write';
// "itSS" means "it() Skip Standalone"
const itSS = process.env.BALENA_CLI_TEST_TYPE === 'standalone' ? it.skip : it;
describe('balena config write', function () {
itSS('updateConfigJson should match expected output', () => {
const testVector: Array<[object, string, any, object]> = [
[{}, 'a.b', 'c', { a: { b: 'c' } }],
[{}, 'a.1', true, { a: { '1': true } }],
[{}, 'a.true', 1, { a: { true: 1 } }],
[{}, 'a.1', 1.1, { a: { '1': 1.1 } }],
[{ a: 'b' }, 'a', 2, { a: 2 }],
[{ a: ['b'] }, 'a', 2, { a: 2 }],
[{ a: ['b'] }, 'a.1', 'c', { a: ['b', 'c'] }],
[{ a: ['b'] }, 'a.2', 'c', { a: ['b', , 'c'] }],
[{ a: { '1': 'b' } }, 'a.1', 'c', { a: { '1': 'c' } }],
[{ a: { '1': 'b' } }, 'a.2', 'c', { a: { '1': 'b', '2': 'c' } }],
// fix: https://forums.balena.io/t/programatically-github-actions-add-udev-rule-to-config-file/337399
[
{ a: 'b' },
'os.udevRules.101',
'ACTION=="add", SUBSYSTEMS=="usb", RUN+="/usr/sbin/nvpmodel -m 0"',
{
a: 'b',
os: {
udevRules: {
'101':
'ACTION=="add", SUBSYSTEMS=="usb", RUN+="/usr/sbin/nvpmodel -m 0"',
},
},
},
],
[
{ os: { udevRules: { '101': 'foo' } } },
'os.udevRules.101',
'bar',
{ os: { udevRules: { '101': 'bar' } } },
],
[
{ os: { udevRules: { '101': 'foo' } } },
'os.udevRules.102',
'bar',
{ os: { udevRules: { '101': 'foo', '102': 'bar' } } },
],
];
for (const [configJson, key, value, expected] of testVector) {
ConfigWriteCmd.updateConfigJson(configJson, key, value);
expect(configJson).to.deep.equal(expected);
}
});
});