-
Notifications
You must be signed in to change notification settings - Fork 128
feat: refactored devices command and added health and status flags. #369
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bflorian
merged 1 commit into
SmartThingsCommunity:master
from
bflorian:device-health-status
Aug 9, 2022
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,5 @@ | ||
| --- | ||
| "@smartthings/cli": patch | ||
| --- | ||
|
|
||
| feat: Refactored devices command and added health and status flags. | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -84,6 +84,22 @@ describe('DevicesCommand', () => { | |
| expect(withLocationsAndRoomsMock).toHaveBeenCalledTimes(0) | ||
| }) | ||
|
|
||
| it('adds health status with health flag', async () => { | ||
| await expect(DevicesCommand.run(['--health'])).resolves.not.toThrow() | ||
|
|
||
| expect(outputListingMock).toHaveBeenCalledTimes(1) | ||
| expect(outputListingMock.mock.calls[0][1].listTableFieldDefinitions) | ||
| .toEqual(['label', 'name', 'type', { label: 'Health', prop: 'healthState.state' }, 'deviceId']) | ||
|
|
||
| const listDevices = outputListingMock.mock.calls[0][3] | ||
|
|
||
| expect(await listDevices()).toBe(devices) | ||
|
|
||
| expect(listSpy).toHaveBeenCalledTimes(1) | ||
| expect(listSpy).toHaveBeenCalledWith(expect.objectContaining({ capability: undefined })) | ||
| expect(withLocationsAndRoomsMock).toHaveBeenCalledTimes(0) | ||
| }) | ||
|
|
||
| it('adds locations with verbose flag', async () => { | ||
| await expect(DevicesCommand.run(['--verbose'])).resolves.not.toThrow() | ||
|
|
||
|
|
@@ -185,7 +201,7 @@ describe('DevicesCommand', () => { | |
| }) | ||
|
|
||
| it('uses devices.get to get device', async () => { | ||
| await expect(DevicesCommand.run(['--capability', 'cmd-line-capability'])).resolves.not.toThrow() | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch. |
||
| await expect(DevicesCommand.run([])).resolves.not.toThrow() | ||
|
|
||
| expect(outputListingMock).toHaveBeenCalledTimes(1) | ||
| expect(outputListingMock.mock.calls[0][1].listTableFieldDefinitions) | ||
|
|
@@ -198,6 +214,65 @@ describe('DevicesCommand', () => { | |
| expect(await getDevice('chosen-device-id')).toBe(device) | ||
|
|
||
| expect(getSpy).toHaveBeenCalledTimes(1) | ||
| expect(getSpy).toHaveBeenCalledWith('chosen-device-id') | ||
| expect(getSpy).toHaveBeenCalledWith('chosen-device-id', { includeStatus: undefined }) | ||
| }) | ||
|
|
||
| it('uses UUID from the command line', async () => { | ||
| const deviceId = 'device-id' | ||
| const getSpy = jest.spyOn(DevicesEndpoint.prototype, 'get').mockImplementation() | ||
|
Comment on lines
+221
to
+222
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These should be declared at the |
||
|
|
||
| outputListingMock.mockImplementationOnce(async (_command, _config, _id, _listFunction, getFunction) => { | ||
| await getFunction(deviceId) | ||
| }) | ||
|
|
||
| await expect(DevicesCommand.run([deviceId])).resolves.not.toThrow() | ||
| expect(outputListing).toBeCalledWith( | ||
| expect.anything(), | ||
| expect.anything(), | ||
| deviceId, | ||
| expect.anything(), | ||
| expect.anything(), | ||
| ) | ||
| expect(getSpy).toBeCalledWith(deviceId, { includeStatus: undefined }) | ||
| }) | ||
|
|
||
| it('includes attribute values when status flag is set', async () => { | ||
| const deviceId = 'device-id' | ||
| const getSpy = jest.spyOn(DevicesEndpoint.prototype, 'get').mockImplementation() | ||
|
|
||
| outputListingMock.mockImplementationOnce(async (_command, _config, _id, _listFunction, getFunction) => { | ||
| await getFunction(deviceId) | ||
| }) | ||
|
|
||
| await expect(DevicesCommand.run([deviceId, '--status'])).resolves.not.toThrow() | ||
| expect(outputListing).toBeCalledWith( | ||
| expect.anything(), | ||
| expect.anything(), | ||
| deviceId, | ||
| expect.anything(), | ||
| expect.anything(), | ||
| ) | ||
| expect(getSpy).toBeCalledWith(deviceId, { includeStatus: true }) | ||
| }) | ||
|
|
||
| it('includes health status when health flag is set', async () => { | ||
| const deviceId = 'device-id' | ||
| const getSpy = jest.spyOn(DevicesEndpoint.prototype, 'get').mockImplementation() | ||
| const getHealthSpy = jest.spyOn(DevicesEndpoint.prototype, 'getHealth').mockImplementation() | ||
|
|
||
| outputListingMock.mockImplementationOnce(async (_command, _config, _id, _listFunction, getFunction) => { | ||
| await getFunction(deviceId) | ||
| }) | ||
|
|
||
| await expect(DevicesCommand.run([deviceId, '--health'])).resolves.not.toThrow() | ||
| expect(outputListing).toBeCalledWith( | ||
| expect.anything(), | ||
| expect.anything(), | ||
| deviceId, | ||
| expect.anything(), | ||
| expect.anything(), | ||
| ) | ||
| expect(getSpy).toBeCalledWith(deviceId, { includeStatus: undefined }) | ||
| expect(getHealthSpy).toBeCalledWith(deviceId) | ||
| }) | ||
| }) | ||
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.
This is minor these are used for release notes and it might be more clear to just say something like
added health and status flags to devices command(no need forfeat:here either).I wonder if we shouldn't come up with some sort of a little style guide for these.