v2.3.0 - Merge pull request #130 from osu-cascades/dev

.nvmrc

@@ -1 +1 @@
-v13.7
+v14.13.1

.tool-versions

@@ -0,0 +1 @@
+nodejs 14.13.1

README.md

@@ -6,7 +6,9 @@
 |Staging Build|[![Build Status](https://travis-ci.org/osu-cascades/hackbot.svg?branch=dev)](https://travis-ci.org/osu-cascades/hackbot)|
 |Maintainability|[![Maintainability](https://api.codeclimate.com/v1/badges/96320fe592c30381915f/maintainability)](https://codeclimate.com/github/osu-cascades/hackbot)|
 |Test Coverage|[![Test Coverage](https://api.codeclimate.com/v1/badges/96320fe592c30381915f/test_coverage)](https://codeclimate.com/github/osu-cascades/hackbot)|
-|GreenKeeper|[![Greenkeeper badge](https://badges.greenkeeper.io/osu-cascades/hackbot.svg)](https://greenkeeper.io/)|
+|Snyk|[![Known Vulnerabilities](https://snyk.io/test/github/osu-cascades/hackbot/badge.svg?targetFile=package.json)](https://snyk.io/test/github/osu-cascades/hackbot?targetFile=package.json)|
+
+
 
 A Discord bot for the Cascades Tech Club [Discord](http://discordapp.com) server. To add a command, see the [Commands](#commands) section below.
 

__tests__/__mocks__/axios.ts

@@ -4,5 +4,8 @@ export default {
   }),
   request: jest.fn().mockResolvedValue({
     data: {}
-  })
+  }),
+  post: jest.fn().mockResolvedValue({
+    data: {}
+  }),
 };

__tests__/commands/hacktoberfest.test.ts

@@ -0,0 +1,17 @@
+import Hacktoberfest from '@/commands/hacktoberfest';
+
+import { message as mockMessage, MockedMessage } from '../mocks/discord';
+
+let sendMock: MockedMessage;
+beforeEach(() => {
+  sendMock = jest.fn();
+  mockMessage.channel.send = sendMock;
+});
+
+describe('Hacktoberfest command', () => {
+  test('hacktoberfest', () => {
+    Hacktoberfest.execute([], mockMessage);
+    const sentMessage = sendMock.mock.calls[0][0];
+    expect(sentMessage.includes('Hacktoberfest')).toEqual(true);
+  });
+});

__tests__/commands/run.test.ts

@@ -0,0 +1,21 @@
+import Run from '@/commands/run';
+import { message as mockMessage, MockedMessage } from '../mocks/discord';
+
+let sendMock: MockedMessage;
+beforeEach(() => {
+    sendMock = jest.fn();
+    mockMessage.channel.send = sendMock;
+    mockMessage.reply = sendMock;
+});
+
+test('Malformed message', () => {
+    mockMessage.content = "Wow this is nowhere near the correct content";
+    Run.execute([], mockMessage);
+    expect(sendMock).lastCalledWith("Sorry, I ran into some problems understanding your message. Here is the error stopping me.\nError: Unable to extract code from Wow this is nowhere near the correct content");
+});
+
+test('Unknown language', () => {
+    mockMessage.content = "```invalidLanguage\nblahblahblah```";
+    Run.execute([], mockMessage);
+    expect(sendMock).lastCalledWith("Unknown language: invalidLanguage")
+});

__tests__/commands/source.test.ts

@@ -1,5 +1,5 @@
-import { message as mockMessage, MockedMessage } from '../mocks/discord';
 import Source from '@/commands/source';
+import { message as mockMessage, MockedMessage } from '../mocks/discord';
 
 let sendMock: MockedMessage;
 beforeEach(() => {

__tests__/commands/version.test.ts

@@ -1,6 +1,6 @@
+import Version from '@/commands/version';
 import { Message } from 'discord.js';
 import { message as mockMessage, MockedMessage } from '../mocks/discord';
-import Version from '@/commands/version';
 
 let sendMock: MockedMessage;
 beforeEach(() => {

__tests__/languages/rust.test.ts

@@ -0,0 +1,21 @@
+import Rust from '@/runners/rust';
+import axiosMock from '../__mocks__/axios';
+
+jest.mock('axios');
+
+test('valid code', async () => {
+    const code = "testCode";
+    let mockResponse = Promise.resolve({ data: { success: true, stdout: "test", stderr: "   Compiling playground v0.0.1 (/playground)\n    Finished dev [unoptimized + debuginfo] target(s) in 0.43s\n     Running `target/debug/playground`\n" } });
+    axiosMock.post.mockResolvedValueOnce(mockResponse);
+    let result = await Rust.execute(code);
+    expect(result).toEqual({ success: true, output: "test" });
+})
+
+test('invalid code', async () => {
+    const code = "testCode";
+    const errorResult = "bad code";
+    let mockResponse = Promise.resolve({ data: { success: false, stdout: "", stderr: errorResult } });
+    axiosMock.post.mockResolvedValueOnce(mockResponse);
+    let result = await Rust.execute(code);
+    expect(result).toEqual({ success: false, output: errorResult });
+})

__tests__/library/commandLoader.test.ts

@@ -1,5 +1,5 @@
-import glob from 'glob';
 import CommandLoader, { ICommandClasses } from '@/library/commandLoader';
+import glob from 'glob';
 
 describe('CommandLoader', () => {
   let commandClasses: ICommandClasses;

__tests__/library/languages.test.ts

@@ -0,0 +1,31 @@
+import Languages from '@/library/languages';
+import IRunner from '@/library/interfaces/iRunner';
+import { ILanguageRunners } from '@/library/languageLoader';
+
+describe('Languages', () => {
+    let mockLanguageRunner: IRunner;
+    let languageRunners: ILanguageRunners;
+    let languages: Languages;
+
+    beforeEach(() => {
+        mockLanguageRunner = {
+            execute: jest.fn()
+        };
+
+        languageRunners = {
+            testLang: mockLanguageRunner,
+        };
+
+        languages = new Languages(languageRunners);
+    });
+
+    test('.names returns language names', () => {
+        const languageNames = ['testLang'];
+        expect(languages.names).toEqual(languageNames);
+    });
+
+    test('Can fetch a command', () => {
+        const testLang = languages.get('testLang');
+        expect(testLang).toBe(mockLanguageRunner);
+    });
+})

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hackbot",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Discord bot for the Cascades Tech Club Discord server.",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
   "author": "osu-cascades",
   "license": "MIT",
   "engines": {
-    "node": "13.7.x"
+    "node": "14.13.x"
   },
   "dependencies": {
     "@types/axios": "^0.14.0",

src/commands/add.ts

@@ -1,5 +1,5 @@
-import { Message } from "discord.js";
 import ICommand from "@/library/interfaces/iCommand";
+import { Message } from "discord.js";
 
 let Add: ICommand;
 

src/commands/format.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 // Hack for implementing with static properties/methods
 let Format: ICommand;

src/commands/gitProfile.ts

@@ -1,7 +1,7 @@
+import ICommand from '@/library/interfaces/iCommand';
 import axios from 'axios';
 import { Message } from 'discord.js';
 import moment from 'moment';
-import ICommand from '@/library/interfaces/iCommand';
 import IGithubProfile from './interfaces/iGithubProfile';
 
 let GitProfile: ICommand;

src/commands/hacktoberfest.ts

@@ -0,0 +1,17 @@
+import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
+
+// Hack for implementing with static properties/methods
+let Hacktoberfest: ICommand;
+export default Hacktoberfest = class {
+
+  static get description(): string {
+    return 'Lists information on how to participate in Hacktoberfest 2020';
+  }
+
+  public static execute(args: string[], msg: Message) {
+    const content = "Hacktoberfest has officially begun! Find out more information at\nhttps://hacktoberfest.digitalocean.com\nand stay tuned for opportunities and workshops from tech club members.";
+    return msg.channel.send(content);
+  }
+
+};

src/commands/help.ts

@@ -1,7 +1,7 @@
-import { Message } from 'discord.js';
 import config from '@/config';
 import Commands from '@/library/commands';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Help: ICommand;
 

src/commands/lmgtfy.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Lmgtfy: ICommand;
 

src/commands/magic8ball.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Magic8Ball: ICommand;
 

src/commands/rules.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Rules: ICommand;
 

src/commands/run.ts

@@ -0,0 +1,61 @@
+import ICommand from '@/library/interfaces/iCommand';
+import Languages from '@/library/languages';
+import { Message } from 'discord.js';
+
+const languages = new Languages();
+
+// Hack for implementing with static properties/methods
+let Run: ICommand;
+export default Run = class {
+
+
+  /* istanbul ignore next */
+  static get description(): string {
+    return 'Executes provided code using a LanguageRunner';
+  }
+
+  public static execute(args: string[], msg: Message) {
+
+    let parseResponse;
+
+    try {
+      parseResponse = this.parseCode(msg.content);
+      if (!languages.get(parseResponse.language)) {
+        msg.channel.send(`Unknown language: ${parseResponse.language}`);
+        return;
+      }
+    } catch (e) {
+      msg.channel.send("Sorry, I ran into some problems understanding your message. Here is the error stopping me.\n" + e);
+      return;
+    }
+
+    const codeRunnerResponse = languages.get(parseResponse.language).execute(parseResponse.code);
+
+    codeRunnerResponse.then((response: { success: any; output: string; }) => {
+      if (response.success) {
+        msg.channel.send("```" + response.output + "```");
+      } else {
+        msg.channel.send(
+          "Unfortunately I was unable to run your code. Here is the error I received.\n```" +
+          response.output +
+          "```"
+        );
+      }
+    });
+
+  }
+
+  // Tries to pull language and source code out of message
+  private static parseCode(messageText: string): { language: string, code: string } {
+    const codeRegex = /(```(.[^\n]*))(\n(.*))(```)/s;
+    const match = codeRegex.exec(messageText);
+
+    // Group 2 = language, group 4 = code
+    if (match && match[2] && match[4]) {
+      return { language: match[2], code: match[4] };
+    } else {
+      throw new Error(`Unable to extract code from ${messageText}`);
+    }
+  }
+
+};

src/commands/say.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Say: ICommand;
 

src/commands/source.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Source: ICommand;
 

src/commands/version.ts

@@ -1,7 +1,7 @@
 import config from '@/config';
+import ICommand from '@/library/interfaces/iCommand';
 import { version } from '@root/package.json';
 import { Message } from 'discord.js';
-import ICommand from '@/library/interfaces/iCommand';
 
 let Version: ICommand;
 

src/commands/weather.ts

@@ -1,7 +1,7 @@
-import axios, { AxiosResponse } from 'axios';
-import { Message } from 'discord.js';
 import config from '@/config';
 import ICommand from '@/library/interfaces/iCommand';
+import axios, { AxiosResponse } from 'axios';
+import { Message } from 'discord.js';
 
 let Weather: ICommand;
 

src/commands/xmas.ts

@@ -1,5 +1,5 @@
-import { Message } from 'discord.js';
 import ICommand from '@/library/interfaces/iCommand';
+import { Message } from 'discord.js';
 
 let Xmas: ICommand;
 

src/index.ts

@@ -5,7 +5,7 @@ import { Client } from 'discord.js';
 const client = new Client();
 const core = new Core(client);
 
-client.on('ready', () => core.ready);
+client.on('ready', () => core.ready());
 
 client.on('message', core.message);
 

src/library/interfaces/iCommand.ts

@@ -1,5 +1,6 @@
 import { Client, Message } from "discord.js";
-import Commands from "@/commands";
+import Commands from "@/library/commands";
+
 
 /**
  * An interface for all commands to extend, representing the API that all

src/library/interfaces/iRunner.ts

@@ -0,0 +1,10 @@
+/**
+ * An interface for all code runners to extend, representing the API that all
+ * subclasses should implement.
+ *
+ * @class Runner
+ */
+
+ export default interface IRunner {
+     execute(code: string): Promise<{success: boolean, output: string}>;
+ }