generator-discord 1.3.2 → 1.3.4

package/templates/rust/Cargo.toml

@@ -6,5 +6,5 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serenity = { version = "0.11.6", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
+serenity = { version = "0.11.7", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
 tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }

package/templates/typescript/package.json

@@ -10,7 +10,7 @@
     "build": "tsc"
   },
   "dependencies": {
-    "discord.js": "^14.13.0",
+    "discord.js": "^14.14.1",
     "typescript": "^5.2.2"
   }
 }

package/test/templates.test.ts

@@ -0,0 +1,147 @@
+import { describe, expect, test } from 'vitest';
+import { createHelpers } from 'yeoman-test';
+import { spawn, exec } from 'child_process';
+import * as dotenv from 'dotenv';
+import path from 'path';
+import url from 'url';
+
+const __dirname = url.fileURLToPath(new URL('../', import.meta.url));
+const DEFAULT_TIMEOUT = 60_000; // 1 minute
+
+dotenv.config();
+
+const { BOT_TOKEN } = process.env;
+if (!BOT_TOKEN) {
+	throw new Error('You must specify a valid bot token in the BOT_TOKEN environment variable');
+}
+
+const defaultAnswers = {
+	botName: 'test-run-bot',
+	botType: 'typescript',
+	botToken: BOT_TOKEN,
+	openWithCode: false,
+};
+
+describe('Check if the templates work', () => {
+	const targetRoot = path.join(__dirname, 'test-temp');
+	const moduleRoot = path.join(__dirname, 'app');
+	const resultRoot = path.join(targetRoot, defaultAnswers.botName);
+
+	test('Should generate and run TypeScript Discord Bot', async () => {
+		const context = createHelpers({}).run(moduleRoot);
+
+		context.targetDirectory = targetRoot;
+		context.cleanTestDirectory(true);
+		await context
+			.onGenerator(generator => {
+				generator.destinationRoot(targetRoot);
+			})
+			.withAnswers(defaultAnswers)
+			.then(async () => {
+				const result = await runBot('node', ['./dist/src/index.js'], resultRoot, DEFAULT_TIMEOUT);
+				expect(result).toContain(BOT_OUTPUT_START);
+			});
+
+		context.cleanup();
+	}, 120_000);
+
+	test.skip('Should generate and run Python Discord Bot', async () => {
+		const context = createHelpers({}).run(moduleRoot);
+
+		context.targetDirectory = targetRoot;
+		context.cleanTestDirectory(true);
+		await context
+			.onGenerator(generator => {
+				generator.destinationRoot(targetRoot);
+			})
+			.withAnswers({ ...defaultAnswers, botType: 'python' })
+			.then(async () => {
+				// install dependencies 
+				await exec('pip3 install -r requirements.txt', { cwd: resultRoot });
+
+				const result = await runBot('python', ['./main.py'], resultRoot, DEFAULT_TIMEOUT);
+				expect(result).toContain(BOT_OUTPUT_START);
+			});
+
+		context.cleanup();
+	}, 120_000);
+
+	test('Should generate and run JavaScript Discord Bot', async () => {
+		const context = createHelpers({}).run(moduleRoot);
+
+		context.targetDirectory = targetRoot;
+		context.cleanTestDirectory(true);
+		await context
+			.onGenerator(generator => {
+				generator.destinationRoot(targetRoot);
+			})
+			.withAnswers({ ...defaultAnswers, botType: 'javascript' })
+			.then(async () => {
+				const result = await runBot('node', ['./src/index.js'], resultRoot, DEFAULT_TIMEOUT);
+				expect(result).toContain(BOT_OUTPUT_START);
+			});
+
+		context.cleanup();
+	}, 120_000);
+
+	test('Should generate and run Rust Discord Bot', async () => {
+		const context = createHelpers({}).run(moduleRoot);
+
+		context.targetDirectory = targetRoot;
+		context.cleanTestDirectory(true);
+		await context
+			.onGenerator(generator => {
+				generator.destinationRoot(targetRoot);
+			})
+			.withAnswers({ ...defaultAnswers, botType: 'rust' })
+			.withArguments(['skip-build'])
+			.then(async () => {
+				const result = await runBot('cargo', ['run', '--release', '--quiet'] , resultRoot, 120_000); // 2 minutes
+				expect(result).toContain(BOT_OUTPUT_START);
+			});
+
+		context.cleanup();
+	}, 180_000); // 3 minutes
+});
+
+/** Run a command in a child process and return the output
+ * @param {string} command The command to run
+ * @param {string[]} args The arguments to pass to the command
+ * @param {string} root The root directory to run the command in
+ * @param {number} timeoutTime The time in milliseconds to wait before timing out
+ * @returns {Promise<string>} The output of the command
+*/
+async function runBot(command: string, args: string[], root: string, timeoutTime: number): Promise<string> {
+	const childProcess = spawn(command, args, { cwd: root, timeout: timeoutTime });
+
+	const result = await new Promise<string>((resolve) => {
+		// timeout
+		const safetyTimeout = setTimeout(() => {
+			resolve('TIMEOUT');
+		}, timeoutTime);
+
+		// output
+		childProcess.stdout.on('data', (data) => {
+			clearTimeout(safetyTimeout);
+
+			resolve(data.toString());
+		});
+
+		childProcess.stderr.on('data', (data) => {
+			clearTimeout(safetyTimeout);
+
+			resolve(data.toString());
+		});
+
+		childProcess.on('close', () => {
+			clearTimeout(safetyTimeout);
+		});
+
+	});
+
+	childProcess.kill('SIGINT');
+	return result;
+}
+
+
+const BOT_OUTPUT_START = 'Bot is logged in as';

package/test/generator.test.ts

@@ -1,127 +0,0 @@
-import { describe, test } from 'vitest';
-import { createHelpers } from 'yeoman-test';
-import path from 'path';
-import url from 'url';
-
-const __dirname = url.fileURLToPath(new URL('../', import.meta.url));
-
-
-const defaultAnswers = {
-	botName: 'test-bot',
-	botType: 'typescript',
-	botToken: 'xxx',
-	openWithCode: false,
-};
-
-describe('Check yeoman generator works', () => {
-	const targetRoot = path.join(__dirname, 'test-temp');
-	const moduleRoot = path.join(__dirname, 'app');
-	const resultRoot = path.join(targetRoot, defaultAnswers.botName);
-
-	test('Should produce TypeScript files', async () => {
-		const context = createHelpers({}).run(moduleRoot);
-		const configJson = path.join(resultRoot, 'config.json');
-
-		context.targetDirectory = targetRoot;
-		context.cleanTestDirectory(true);
-		await context
-			.onGenerator(generator => {
-				generator.destinationRoot(targetRoot);
-			})
-			.withAnswers(defaultAnswers)
-			.withArguments(['skip-install', 'skip-build'])
-			.then((result) => {
-				const files = [
-					configJson,
-					resultRoot + '/src/index.ts',
-					resultRoot + '/tsconfig.json',
-					resultRoot + '/package.json',
-				];
-				result.assertFile(files);
-				result.assertJsonFileContent(configJson, CONFIG_JSON_EXPECTED);
-			});
-		// context.cleanup();
-	}, 120_000);
-
-	test('Should produce Python files', async () => {
-		const context = createHelpers({}).run(moduleRoot);
-		const mainPy = path.join(resultRoot, 'main.py');
-
-		context.targetDirectory = targetRoot;
-		context.cleanTestDirectory(true);
-		await context
-			.onGenerator(generator => {
-				generator.destinationRoot(targetRoot);
-			})
-			.withAnswers({ ...defaultAnswers, botType: 'python' })
-			.then((result) => {
-				const files = [
-					mainPy,
-					resultRoot + '/requirements.txt',
-				];
-				result.assertFile(files);
-				// result.assertFileContent(mainPy, PYTHON_BOT_EXPECTED);
-			});
-		context.cleanup();
-	}, 120_000);
-
-	test('Should produce Rust files', async () => {
-		const context = createHelpers({}).run(moduleRoot);
-		const cargoToml = path.join(resultRoot, 'Cargo.toml');
-
-		context.targetDirectory = targetRoot;
-		context.cleanTestDirectory(true);
-		await context
-			.onGenerator(generator => {
-				generator.destinationRoot(targetRoot);
-			})
-			.withAnswers({ ...defaultAnswers, botType: 'rust' })
-			.then((result) => {
-				const files = [
-					resultRoot + '/src/main.rs',
-					cargoToml
-				];
-				result.assertFile(files);
-				result.assertFileContent(cargoToml, CARGO_TOML_EXPECTED);
-			});
-		context.cleanup();
-	}, 120_000);
-});
-
-const CONFIG_JSON_EXPECTED: Record<string, string> = {
-	'token': 'xxx'
-};
-
-const PYTHON_BOT_EXPECTED = `import discord
-
-intents = discord.Intents.default()
-intents.message_content = True
-
-client = discord.Client(intents=intents)
-
-@client.event
-async def on_ready():
-    print(f'Bot is logged in as  {client.user}')
-
-@client.event
-async def on_message(message):
-    if message.author == client.user:
-        return
-
-    if message.content.startswith('!ping'):
-        await message.channel.send('Pong!')
-
-client.run('${defaultAnswers.botToken}')
-`;
-
-const CARGO_TOML_EXPECTED = `[package]
-name = "${defaultAnswers.botName}" 
-version = "0.1.0"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-serenity = { version = "0.11.6", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] }
-tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }
-`;