actions/cmake-action
1
0
Fork 0
mirror of https://github.com/threeal/cmake-action.git synced 2025-04-21 11:01:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: use exec function in configureProject and buildProject functions

Browse Source 
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
This commit is contained in:
Alfi Maulana 2024-11-21 22:14:39 +07:00
parent d91c238854
commit 1ee26694a0
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
4 changed files with 78 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
dist/action.mjs generated vendored
View File

@ -2,7 +2,7 @@ import 'node:fs';
import fsPromises from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';
import { execFileSync } from 'node:child_process';
import { spawn } from 'node:child_process';
/**
* @internal
@ -52,32 +52,64 @@ function logError(err) {
}
/**
* Configures the build system of a CMake project.
* Executes a command with the given arguments.
*
* @param context - The action context.
* The command is executed with `stdin` ignored and both `stdout` and `stderr` inherited by the parent process.
*
* @param command The command to execute.
* @param args The arguments to pass to the command.
* @returns A promise that resolves when the command exits successfully or rejects if it exits with a non-zero status code or encounters an error.
*/
function configureProject(context) {
async function exec(command, args) {
return new Promise((resolve, reject) => {
const proc = spawn(command, args, {
stdio: ["ignore", "inherit", "inherit"],
});
proc.on("error", reject);
proc.on("close", (code) => {
if (code === 0) {
resolve();
}
else {
reject(new Error(`Command exited with status code ${code}`));
}
});
});
}
/**
* Configures the build system for a CMake project.
*
* Constructs and runs the `cmake` command to configure the project with the specified
* source directory, build directory, generator, options, and additional arguments.
*
* @param context - The action context containing configuration details.
* @returns A promise that resolves when the build system is successfully configured.
*/
async function configureProject(context) {
const configureArgs = [];
if (context.sourceDir) {
configureArgs.push(context.sourceDir);
}
configureArgs.push("-B", context.buildDir);
if (context.configure.generator) {
configureArgs.push(...["-G", context.configure.generator]);
configureArgs.push("-G", context.configure.generator);
}
configureArgs.push(...context.configure.options.map((opt) => "-D" + opt));
configureArgs.push(...context.configure.args);
execFileSync("cmake", configureArgs, { stdio: "inherit" });
await exec("cmake", configureArgs);
}
/**
* Build a CMake project.
* Builds a CMake project.
*
* @param context - The action context.
* Runs the `cmake --build` command to build the project using the specified
* build directory and additional arguments.
*
* @param context - The action context containing build details.
* @returns A promise that resolves when the project is successfully built.
*/
function buildProject(context) {
execFileSync("cmake", ["--build", context.buildDir, ...context.build.args], {
stdio: "inherit",
});
async function buildProject(context) {
await exec("cmake", ["--build", context.buildDir, ...context.build.args]);
}
var shellQuote = {};
@ -393,10 +425,10 @@ function getContext() {
try {
const context = getContext();
configureProject(context);
await configureProject(context);
await setOutput("build-dir", context.buildDir);
if (context.build.enabled) {
buildProject(context);
await buildProject(context);
}
}
catch (err) {

4
src/action.ts
View File

@ -5,12 +5,12 @@ import { getContext } from "./context.js";
try {
const context = getContext();
configureProject(context);
await configureProject(context);
await setOutput("build-dir", context.buildDir);
if (context.build.enabled) {
buildProject(context);
await buildProject(context);
}
} catch (err) {
logError(err);

32
src/cmake.test.ts
View File

@ -21,8 +21,8 @@ const defaultContext: Context = {
},
};
jest.unstable_mockModule("node:child_process", () => ({
execFileSync: jest.fn(),
jest.unstable_mockModule("./exec.js", () => ({
exec: jest.fn(),
}));
describe("configure a CMake project", () => {
@ -101,18 +101,14 @@ describe("configure a CMake project", () => {
for (const testCase of testCases) {
it(`should execute the correct command ${testCase.name}`, async () => {
const { configureProject } = await import("./cmake.js");
const { execFileSync } = await import("node:child_process");
const { exec } = await import("./exec.js");
jest.mocked(execFileSync).mockReset();
jest.mocked(exec).mockReset();
configureProject({ ...defaultContext, ...testCase.context });
await configureProject({ ...defaultContext, ...testCase.context });
expect(execFileSync).toHaveBeenCalledTimes(1);
expect(execFileSync).toHaveBeenLastCalledWith(
"cmake",
testCase.expectedArgs,
{ stdio: "inherit" },
);
expect(exec).toHaveBeenCalledTimes(1);
expect(exec).toHaveBeenLastCalledWith("cmake", testCase.expectedArgs);
});
}
});
@ -149,18 +145,14 @@ describe("build a CMake project", () => {
for (const testCase of testCases) {
it(`should execute the correct command ${testCase.name}`, async () => {
const { buildProject } = await import("./cmake.js");
const { execFileSync } = await import("node:child_process");
const { exec } = await import("./exec.js");
jest.mocked(execFileSync).mockReset();
jest.mocked(exec).mockReset();
buildProject({ ...defaultContext, ...testCase.context });
await buildProject({ ...defaultContext, ...testCase.context });
expect(execFileSync).toHaveBeenCalledTimes(1);
expect(execFileSync).toHaveBeenLastCalledWith(
"cmake",
testCase.expectedArgs,
{ stdio: "inherit" },
);
expect(exec).toHaveBeenCalledTimes(1);
expect(exec).toHaveBeenLastCalledWith("cmake", testCase.expectedArgs);
});
}
});

30
src/cmake.ts
View File

@ -1,12 +1,16 @@
import { execFileSync } from "node:child_process";
import { exec } from "./exec.js";
import type { Context } from "./context.js";
/**
* Configures the build system of a CMake project.
* Configures the build system for a CMake project.
*
* @param context - The action context.
* Constructs and runs the `cmake` command to configure the project with the specified
* source directory, build directory, generator, options, and additional arguments.
*
* @param context - The action context containing configuration details.
* @returns A promise that resolves when the build system is successfully configured.
*/
export function configureProject(context: Context): void {
export async function configureProject(context: Context): Promise<void> {
const configureArgs = [];
if (context.sourceDir) {
@ -16,22 +20,24 @@ export function configureProject(context: Context): void {
configureArgs.push("-B", context.buildDir);
if (context.configure.generator) {
configureArgs.push(...["-G", context.configure.generator]);
configureArgs.push("-G", context.configure.generator);
}
configureArgs.push(...context.configure.options.map((opt) => "-D" + opt));
configureArgs.push(...context.configure.args);
execFileSync("cmake", configureArgs, { stdio: "inherit" });
await exec("cmake", configureArgs);
}
/**
* Build a CMake project.
* Builds a CMake project.
*
* @param context - The action context.
* Runs the `cmake --build` command to build the project using the specified
* build directory and additional arguments.
*
* @param context - The action context containing build details.
* @returns A promise that resolves when the project is successfully built.
*/
export function buildProject(context: Context): void {
execFileSync("cmake", ["--build", context.buildDir, ...context.build.args], {
stdio: "inherit",
});
export async function buildProject(context: Context): Promise<void> {
await exec("cmake", ["--build", context.buildDir, ...context.build.args]);
}