Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/famous-actors-mix.md
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.
Copy link
Collaborator

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 for feat: here either).

I wonder if we shouldn't come up with some sort of a little style guide for these.

79 changes: 77 additions & 2 deletions packages/cli/src/__tests__/commands/devices.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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()

Expand Down Expand Up @@ -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()
Copy link
Collaborator

Choose a reason for hiding this comment

The 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)
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should be declared at the describe level to reuse throughout the tests.


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)
})
})
Loading