Added internalName option for spo field commands #6379
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
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
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
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 |
|---|---|---|
|
|
@@ -94,6 +94,18 @@ describe(commands.FIELD_REMOVE, () => { | |
| assert(promptIssued); | ||
| }); | ||
|
|
||
| it('prompts before removing field when confirmation argument not passed (internalName)', async () => { | ||
| await command.action(logger, { options: { internalName: 'myfield1', webUrl: 'https://contoso.sharepoint.com' } }); | ||
|
|
||
| assert(promptIssued); | ||
| }); | ||
|
|
||
| it('prompts before removing list column when confirmation argument not passed (internalName)', async () => { | ||
| await command.action(logger, { options: { internalName: 'myfield1', webUrl: 'https://contoso.sharepoint.com', listTitle: 'My List' } }); | ||
|
|
||
| assert(promptIssued); | ||
| }); | ||
|
|
||
| it('aborts removing field when prompt not confirmed', async () => { | ||
| sinonUtil.restore(cli.promptForConfirmation); | ||
| sinon.stub(cli, 'promptForConfirmation').resolves(false); | ||
|
|
@@ -454,6 +466,51 @@ describe(commands.FIELD_REMOVE, () => { | |
| assert.strictEqual(getStub.lastCall.args[0].url, 'https://contoso.sharepoint.com/sites/portal/_api/web/lists(guid\'03e45e84-1992-4d42-9116-26f756012634\')/fields/getbyinternalnameortitle(\'Title\')'); | ||
| }); | ||
|
|
||
| it('calls the correct get url when field internalName and list title specified (verbose)', async () => { | ||
| const getStub = sinon.stub(request, 'post').callsFake(async (opts) => { | ||
| if ((opts.url as string).indexOf(`/_api/web/lists`) > -1) { | ||
|
There was a problem hiding this comment. Same here, let's use full URLs |
||
| return { | ||
| "Id": "03e45e84-1992-4d42-9116-26f756012634" | ||
| }; | ||
| } | ||
|
|
||
| throw 'Invalid request'; | ||
| }); | ||
|
|
||
| await command.action(logger, { options: { debug: true, verbose: true, webUrl: 'https://contoso.sharepoint.com/sites/portal', internalName: 'Title', listTitle: 'Documents', force: true } }); | ||
| assert.strictEqual(getStub.lastCall.args[0].url, 'https://contoso.sharepoint.com/sites/portal/_api/web/lists/getByTitle(\'Documents\')/fields/getbyinternalnameortitle(\'Title\')'); | ||
| }); | ||
|
|
||
| it('calls the correct get url when field internalName and list title specified', async () => { | ||
| const getStub = sinon.stub(request, 'post').callsFake(async (opts) => { | ||
| if ((opts.url as string).indexOf(`/_api/web/lists`) > -1) { | ||
| return { | ||
| "Id": "03e45e84-1992-4d42-9116-26f756012634" | ||
| }; | ||
| } | ||
|
|
||
| throw 'Invalid request'; | ||
| }); | ||
|
|
||
| await command.action(logger, { options: { webUrl: 'https://contoso.sharepoint.com/sites/portal', internalName: 'Title', listTitle: 'Documents', force: true } }); | ||
| assert.strictEqual(getStub.lastCall.args[0].url, 'https://contoso.sharepoint.com/sites/portal/_api/web/lists/getByTitle(\'Documents\')/fields/getbyinternalnameortitle(\'Title\')'); | ||
| }); | ||
|
|
||
| it('calls the correct get url when field internalName and list url specified', async () => { | ||
| const getStub = sinon.stub(request, 'post').callsFake(async (opts) => { | ||
| if ((opts.url as string).indexOf(`/_api/web/lists`) > -1) { | ||
| return { | ||
| "Id": "03e45e84-1992-4d42-9116-26f756012634" | ||
| }; | ||
| } | ||
|
|
||
| throw 'Invalid request'; | ||
| }); | ||
|
|
||
| await command.action(logger, { options: { debug: true, webUrl: 'https://contoso.sharepoint.com/sites/portal', internalName: 'Title', listId: '03e45e84-1992-4d42-9116-26f756012634', force: true } }); | ||
| assert.strictEqual(getStub.lastCall.args[0].url, 'https://contoso.sharepoint.com/sites/portal/_api/web/lists(guid\'03e45e84-1992-4d42-9116-26f756012634\')/fields/getbyinternalnameortitle(\'Title\')'); | ||
| }); | ||
|
|
||
| it('correctly handles site column not found', async () => { | ||
| const error = { | ||
| error: { | ||
|
|
@@ -534,7 +591,7 @@ describe(commands.FIELD_REMOVE, () => { | |
| assert(containsTypeOption); | ||
| }); | ||
|
|
||
| it('fails validation if either of id, title and internalName options are not passed', async () => { | ||
| sinon.stub(cli, 'getSettingWithDefaultValue').callsFake((settingName, defaultValue) => { | ||
| if (settingName === settingsNames.prompt) { | ||
| return false; | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ interface Options extends GlobalOptions { | |
| group?: string; | ||
| listTitle?: string; | ||
| title?: string; | ||
| internalName?: string; | ||
| listUrl?: string; | ||
| webUrl: string; | ||
| } | ||
|
|
@@ -50,6 +51,7 @@ class SpoFieldRemoveCommand extends SpoCommand { | |
| id: typeof args.options.id !== 'undefined', | ||
| group: typeof args.options.group !== 'undefined', | ||
| title: typeof args.options.title !== 'undefined', | ||
| internalName: typeof args.options.internalName !== 'undefined', | ||
| force: (!(!args.options.force)).toString() | ||
| }); | ||
| }); | ||
|
|
@@ -75,6 +77,9 @@ class SpoFieldRemoveCommand extends SpoCommand { | |
| { | ||
| option: '-t, --title [title]' | ||
| }, | ||
| { | ||
| option: '--internalName [internalName]' | ||
| }, | ||
| { | ||
| option: '-g, --group [group]' | ||
| }, | ||
|
|
@@ -106,7 +111,7 @@ class SpoFieldRemoveCommand extends SpoCommand { | |
| } | ||
|
|
||
| #initOptionSets(): void { | ||
| this.optionSets.push({ options: ['id', 'title', 'internalName', 'group'] }); | ||
| } | ||
|
|
||
| public async commandAction(logger: Logger, args: CommandArgs): Promise<void> { | ||
|
|
@@ -191,7 +196,8 @@ class SpoFieldRemoveCommand extends SpoCommand { | |
| } | ||
| else { | ||
| try { | ||
| const columnName: string | undefined = args.options.title ? args.options.title : args.options.internalName; | ||
| await removeField(listRestUrl, args.options.id, columnName); | ||
| // REST post call doesn't return anything | ||
| } | ||
| catch (err: any) { | ||
|
|
@@ -204,7 +210,7 @@ class SpoFieldRemoveCommand extends SpoCommand { | |
| await prepareRemoval(); | ||
| } | ||
| else { | ||
| const confirmMessage: string = `Are you sure you want to remove the ${args.options.group ? 'fields' : 'field'} ${args.options.id || args.options.title || args.options.internalName || 'from group ' + args.options.group} ${messageEnd}?`; | ||
|
|
||
| const result = await cli.promptForConfirmation({ message: confirmMessage }); | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, let's use full url's