Adds teams channel get command solving pnp#808

docs/manual/docs/cmd/graph/teams/teams-channel-get.md

@@ -0,0 +1,35 @@
+# graph teams channel get
+
+Gets information about the specific Microsoft Teams team channel
+
+## Usage
+
+```sh
+graph teams channel get [options]
+```
+
+## Options
+
+Option|Description
+------|-----------
+`--help`| output usage information
+`-i, --teamId <teamId>`|The ID of the team to which the channel belongs
+`-c, --channelId <channelId>`|The ID of the channel for which to retrieve more information
+`-o, --output [output]`|Output type. `json|text`. Default `text`
+`--verbose`|Runs command with verbose logging
+`--debug`|Runs command with debug logging
+
+!!! important
+    Before using this command, log in to the Microsoft Graph, using the [graph login](../login.md) command
+
+## Remarks
+
+To get information of a specified channel in the given Microsoft Teams team, you have to first log in to the Microsoft Graph using the [graph login](../login.md) command, eg. `graph login`.
+
+## Examples
+
+Get information about Microsoft Teams team channel with id _19:493665404ebd4a18adb8a980a31b4986@thread.skype_
+
+```sh
+graph teams channel get --teamId '00000000-0000-0000-0000-000000000000' --channelId '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+```

docs/manual/mkdocs.yml

@@ -255,6 +255,7 @@ nav:
         - teams app uninstall: 'cmd/graph/teams/teams-app-uninstall.md'
         - teams app update: 'cmd/graph/teams/teams-app-update.md'
         - teams channel add: 'cmd/graph/teams/teams-channel-add.md'
+        - teams channel get: 'cmd/graph/teams/teams-channel-get.md'
         - teams channel list: 'cmd/graph/teams/teams-channel-list.md'
         - teams channel set: 'cmd/graph/teams/teams-channel-set.md'
         - teams funsettings list: 'cmd/graph/teams/teams-funsettings-list.md'

src/o365/graph/commands.ts

@@ -35,6 +35,7 @@ export default {
   TEAMS_GUESTSETTINGS_SET: `${prefix} teams guestsettings set`,
   TEAMS_LIST: `${prefix} teams list`,
   TEAMS_CHANNEL_ADD: `${prefix} teams channel add`,
+  TEAMS_CHANNEL_GET: `${prefix} teams channel get`,
   TEAMS_CHANNEL_LIST:`${prefix} teams channel list`,
   TEAMS_CHANNEL_MESSAGE_GET: `${prefix} teams channel message get`,
   TEAMS_CHANNEL_SET: `${prefix} teams channel set`,

src/o365/graph/commands/teams/teams-channel-get.spec.ts

@@ -0,0 +1,316 @@
+import commands from '../../commands';
+import Command, { CommandOption, CommandError, CommandValidate } from '../../../../Command';
+import * as sinon from 'sinon';
+import appInsights from '../../../../appInsights';
+import auth from '../../GraphAuth';
+const command: Command = require('./teams-channel-get');
+import * as assert from 'assert';
+import * as request from 'request-promise-native';
+import Utils from '../../../../Utils';
+import { Service } from '../../../../Auth';
+
+describe(commands.TEAMS_CHANNEL_GET, () => {
+  let vorpal: Vorpal;
+  let log: string[];
+  let cmdInstance: any;
+  let trackEvent: any;
+  let telemetry: any;
+  let cmdInstanceLogSpy: sinon.SinonSpy;
+  before(() => {
+    sinon.stub(auth, 'restoreAuth').callsFake(() => Promise.resolve());
+    sinon.stub(auth, 'ensureAccessToken').callsFake(() => { return Promise.resolve('ABC'); });
+    trackEvent = sinon.stub(appInsights, 'trackEvent').callsFake((t) => {
+      telemetry = t;
+    });
+  });
+
+  beforeEach(() => {
+    vorpal = require('../../../../vorpal-init');
+    log = [];
+    cmdInstance = {
+      log: (msg: string) => {
+        log.push(msg);
+      }
+    };
+    cmdInstanceLogSpy = sinon.spy(cmdInstance, 'log');
+    auth.service = new Service('https://graph.microsoft.com');
+    telemetry = null;
+    (command as any).items = [];
+  });
+
+  afterEach(() => {
+    Utils.restore([
+      vorpal.find,
+      request.get,
+      request.patch
+    ]);
+  });
+
+  after(() => {
+    Utils.restore([
+      appInsights.trackEvent,
+      auth.ensureAccessToken,
+      auth.restoreAuth
+    ]);
+  });
+
+  it('has correct name', () => {
+    assert.equal(command.name.startsWith(commands.TEAMS_CHANNEL_GET), true);
+  });
+
+  it('has a description', () => {
+    assert.notEqual(command.description, null);
+  });
+
+  it('calls telemetry', (done) => {
+    cmdInstance.action = command.action();
+    cmdInstance.action({ options: {} }, () => {
+      try {
+        assert(trackEvent.called);
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('logs correct telemetry event', (done) => {
+    cmdInstance.action = command.action();
+    cmdInstance.action({ options: {} }, () => {
+      try {
+        assert.equal(telemetry.name, commands.TEAMS_CHANNEL_GET);
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('fails validation if the teamId is not provided.', (done) => {
+    const actual = (command.validate() as CommandValidate)({
+      options: {
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    });
+    assert.notEqual(actual, true);
+    done();
+  });
+
+  it('fails validation if the teamId is not a valid guid.', () => {
+    const actual = (command.validate() as CommandValidate)({
+      options: {
+        teamId: 'invalid',
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    });
+    assert.notEqual(actual, true);
+  });
+
+  it('fails validation when no channelId is specified', (done) => {
+    const actual = (command.validate() as CommandValidate)({
+      options: {
+        teamId: '6703ac8a-c49b-4fd4-8223-28f0ac3a6402'
+      }
+    });
+    assert.notEqual(actual, true);
+    done();
+  });
+
+  it('correctly validates the when all options are valid', () => {
+    const actual = (command.validate() as CommandValidate)({
+      options: {
+        teamId: '6703ac8a-c49b-4fd4-8223-28f0ac3a6402',
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    });
+    assert.equal(actual, true);
+  });
+
+  it('fails to get channel information due to wrong channel id', (done) => {
+    sinon.stub(request, 'get').callsFake((opts) => {
+      if (opts.url === `https://graph.microsoft.com/v1.0/teams/39958f28-eefb-4006-8f83-13b6ac2a4a7f/channels/19%3A493665404ebd4a18adb8a980a31b4986%40thread.skype`) {
+        return Promise.reject({
+          "error": {
+              "code": "ItemNotFound",
+              "message": "Failed to execute Skype backend request GetThreadS2SRequest.",
+              "innerError": {
+                  "request-id": "4bebd0d2-d154-491b-b73f-d59ad39646fb",
+                  "date": "2019-04-06T13:40:51"
+              }
+          }
+      });
+      }
+      return Promise.reject('Invalid request');
+    });
+    auth.service = new Service();
+    auth.service.connected = true;
+    auth.service.resource = 'https://graph.microsoft.com';
+    cmdInstance.action = command.action();
+    cmdInstance.action({
+      options: {
+        debug: true,
+        teamId: '39958f28-eefb-4006-8f83-13b6ac2a4a7f',
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    }, (err?: any) => {
+      try {
+        assert.equal(JSON.stringify(err), JSON.stringify(new CommandError(`Failed to execute Skype backend request GetThreadS2SRequest.`)));
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('should get channel information for the Microsoft Teams team', (done) => {
+    sinon.stub(request, 'get').callsFake((opts) => {
+      if (opts.url === `https://graph.microsoft.com/v1.0/teams/39958f28-eefb-4006-8f83-13b6ac2a4a7f/channels/19%3A493665404ebd4a18adb8a980a31b4986%40thread.skype`) {
+        return Promise.resolve({
+          "id":"19:493665404ebd4a18adb8a980a31b4986@thread.skype",
+          "displayName":"channel1",
+          "description": null,
+          "email":"",
+          "webUrl":"https://teams.microsoft.com/l/channel/19%3a493665404ebd4a18adb8a980a31b4986%40thread.skype/channel1?groupId=39958f28-eefb-4006-8f83-13b6ac2a4a7f&tenantId=ea1787c6-7ce2-4e71-be47-5e0deb30f9e4"});
+      }
+      return Promise.reject('Invalid request');
+    });
+    auth.service = new Service();
+    auth.service.connected = true;
+    auth.service.resource = 'https://graph.microsoft.com';
+    cmdInstance.action = command.action();
+    cmdInstance.action({
+      options: {
+        teamId: '39958f28-eefb-4006-8f83-13b6ac2a4a7f',
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    }, () => {
+      try {
+        const call: sinon.SinonSpyCall = cmdInstanceLogSpy.lastCall;
+        assert.equal(call.args[0].id, '19:493665404ebd4a18adb8a980a31b4986@thread.skype');
+        assert.equal(call.args[0].displayName, 'channel1');
+        assert.equal(call.args[0].description, null);
+        assert.equal(call.args[0].email, '');
+        assert.equal(call.args[0].webUrl, 'https://teams.microsoft.com/l/channel/19%3a493665404ebd4a18adb8a980a31b4986%40thread.skype/channel1?groupId=39958f28-eefb-4006-8f83-13b6ac2a4a7f&tenantId=ea1787c6-7ce2-4e71-be47-5e0deb30f9e4');
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('should get channel information for the Microsoft Teams team (debug)', (done) => {
+    sinon.stub(request, 'get').callsFake((opts) => {
+      if (opts.url === `https://graph.microsoft.com/v1.0/teams/39958f28-eefb-4006-8f83-13b6ac2a4a7f/channels/19%3A493665404ebd4a18adb8a980a31b4986%40thread.skype`) {
+        return Promise.resolve({
+          "id":"19:493665404ebd4a18adb8a980a31b4986@thread.skype",
+          "displayName":"channel1",
+          "description": null,
+          "email":"",
+          "webUrl":"https://teams.microsoft.com/l/channel/19%3a493665404ebd4a18adb8a980a31b4986%40thread.skype/channel1?groupId=39958f28-eefb-4006-8f83-13b6ac2a4a7f&tenantId=ea1787c6-7ce2-4e71-be47-5e0deb30f9e4"});
+      }
+      return Promise.reject('Invalid request');
+    });
+    auth.service = new Service();
+    auth.service.connected = true;
+    auth.service.resource = 'https://graph.microsoft.com';
+    cmdInstance.action = command.action();
+    cmdInstance.action({
+      options: {
+        debug: true,
+        teamId: '39958f28-eefb-4006-8f83-13b6ac2a4a7f',
+        channelId: '19:493665404ebd4a18adb8a980a31b4986@thread.skype'
+      }
+    }, () => {
+      try {
+        const call: sinon.SinonSpyCall = cmdInstanceLogSpy.getCall(cmdInstanceLogSpy.callCount - 2);
+        assert.equal(call.args[0].id, '19:493665404ebd4a18adb8a980a31b4986@thread.skype');
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('aborts when not logged in to Microsoft Graph', (done) => {
+    auth.service = new Service();
+    auth.service.connected = false;
+    cmdInstance.action = command.action();
+    cmdInstance.action({ options: { debug: true } }, (err?: any) => {
+      try {
+        assert.equal(JSON.stringify(err), JSON.stringify(new CommandError('Log in to the Microsoft Graph first')));
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('supports debug mode', () => {
+    const options = (command.options() as CommandOption[]);
+    let containsOption = false;
+    options.forEach(o => {
+      if (o.option === '--debug') {
+        containsOption = true;
+      }
+    });
+    assert(containsOption);
+  });
+
+  it('has help referring to the right command', () => {
+    const cmd: any = {
+      log: (msg: string) => { },
+      prompt: () => { },
+      helpInformation: () => { }
+    };
+    const find = sinon.stub(vorpal, 'find').callsFake(() => cmd);
+    cmd.help = command.help();
+    cmd.help({}, () => { });
+    assert(find.calledWith(commands.TEAMS_CHANNEL_GET));
+  });
+
+  it('has help with examples', () => {
+    const _log: string[] = [];
+    const cmd: any = {
+      log: (msg: string) => {
+        _log.push(msg);
+      },
+      prompt: () => { },
+      helpInformation: () => { }
+    };
+    sinon.stub(vorpal, 'find').callsFake(() => cmd);
+    cmd.help = command.help();
+    cmd.help({}, () => { });
+    let containsExamples: boolean = false;
+    _log.forEach(l => {
+      if (l && l.indexOf('Examples:') > -1) {
+        containsExamples = true;
+      }
+    });
+    Utils.restore(vorpal.find);
+    assert(containsExamples);
+  });
+
+  it('correctly handles lack of valid access token', (done) => {
+    Utils.restore(auth.ensureAccessToken);
+    sinon.stub(auth, 'ensureAccessToken').callsFake(() => { return Promise.reject(new Error('Error getting access token')); });
+    auth.service = new Service();
+    auth.service.connected = true;
+    auth.service.resource = 'https://graph.microsoft.com';
+    cmdInstance.action = command.action();
+    cmdInstance.action({ options: { debug: true } }, (err?: any) => {
+      try {
+        assert.equal(JSON.stringify(err), JSON.stringify(new CommandError('Error getting access token')));
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+});