Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): gherkin command init with TypeScript #4366

Merged
merged 3 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
27 changes: 20 additions & 7 deletions lib/command/gherkin/init.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,19 @@ Given('I have a defined step', () => {
module.exports = function (genPath) {
const testsPath = getTestRoot(genPath);
const config = getConfig(testsPath);
let extension = "js";
let configFile = path.join(testsPath, `codecept.conf.${extension}`);

if (!fileExists(configFile)) {
extension = "ts";
configFile = path.join(testsPath, `codecept.conf.${extension}`);
if (!fileExists(configFile)) {
output.error(
`Can't initializing Gherkin. This command must run on already initialized project`
);
process.exit(1);
}
}

output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
output.print('--------------------------');
Expand All @@ -53,18 +66,18 @@ module.exports = function (genPath) {
output.success(`Created ${dir}, place step definitions into it`);
}

if (safeFileWrite(path.join(dir, 'steps.js'), stepsFile)) {
output.success('Created sample steps file: step_definitions/steps.js');
if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
output.success(
`Created sample steps file: step_definitions/steps.${extension}`
);
}

config.gherkin = {
features: './features/*.feature',
steps: [
'./step_definitions/steps.js',
],
features: "./features/*.feature",
steps: [`./step_definitions/steps.${extension}`],
};

updateConfig(testsPath, config);
updateConfig(testsPath, config, extension);

output.success('Gherkin setup is done.');
output.success('Start writing feature files and implement corresponding steps.');
Expand Down
8 changes: 4 additions & 4 deletions lib/command/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ function fail(msg) {

module.exports.fail = fail;

function updateConfig(testsPath, config, key, extension = 'js') {
function updateConfig(testsPath, config, extension) {
const configFile = path.join(testsPath, `codecept.conf.${extension}`);
if (!fileExists(configFile)) {
console.log();
const msg = `codecept.conf.${extension} config can\'t be updated automatically`;
console.log();
console.log(`${output.colors.bold.red(msg)}`);
console.log('Please update it manually:');
console.log(`${output.colors.bold.red("Please update it manually:")}`);
console.log();
console.log(`${key}: ${config[key]}`);
console.log(config);
console.log();
return;
}
Expand Down
16 changes: 16 additions & 0 deletions test/data/sandbox/configs/gherkin/config_js/codecept.conf.init.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/** @type {CodeceptJS.MainConfig} */
exports.config = {
tests: "./*_test.js",
output: "./output",
helpers: {
Playwright: {
browser: "chromium",
url: "http://localhost",
show: true,
},
},
include: {
I: "./steps_file.js",
},
name: "CodeceptJS",
};
15 changes: 15 additions & 0 deletions test/data/sandbox/configs/gherkin/config_ts/codecept.conf.init.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
export const config: CodeceptJS.MainConfig = {
tests: "./*_test.ts",
output: "./output",
helpers: {
Playwright: {
browser: "chromium",
url: "http://localhost",
show: true
}
},
include: {
I: "./steps_file"
},
name: "CodeceptJS"
}
93 changes: 93 additions & 0 deletions test/runner/gherkin_test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
const assert = require("assert");
const path = require("path");
const fs = require("fs");
const exec = require("child_process").exec;

const runner = path.join(__dirname, "/../../bin/codecept.js");
const codecept_dir = path.join(__dirname, "/../data/sandbox/configs/gherkin/");

describe("gherkin bdd commands", () => {
describe("bdd:init", () => {
let codecept_dir_js = path.join(codecept_dir, "config_js");
let codecept_dir_ts = path.join(codecept_dir, "config_ts");

beforeEach(() => {
fs.copyFileSync(
path.join(codecept_dir_js, "codecept.conf.init.js"),
path.join(codecept_dir_js, "codecept.conf.js")
);
fs.copyFileSync(
path.join(codecept_dir_ts, "codecept.conf.init.ts"),
path.join(codecept_dir_ts, "codecept.conf.ts")
);
});

afterEach(() => {
try {
fs.rmSync(path.join(codecept_dir_js, "codecept.conf.js"));
fs.rmSync(path.join(codecept_dir_js, "features"), {
recursive: true,
});
fs.rmSync(path.join(codecept_dir_js, "step_definitions"), {
recursive: true,
});
} catch (e) {}
try {
fs.rmSync(path.join(codecept_dir_ts, "codecept.conf.ts"));
fs.rmSync(path.join(codecept_dir_ts, "features"), {
recursive: true,
});
fs.rmSync(path.join(codecept_dir_ts, "step_definitions"), {
recursive: true,
});
} catch (e) {}
});

[
{
codecept_dir_test: codecept_dir_js,
extension: "js",
},
{
codecept_dir_test: codecept_dir_ts,
extension: "ts",
},
].forEach(({ codecept_dir_test, extension }) => {
it(`prepare CodeceptJS to run feature files (codecept.conf.${extension})`, (done) => {
exec(`${runner} gherkin:init ${codecept_dir_test}`, (err, stdout) => {
let dir = path.join(codecept_dir_test, "features");

stdout.should.include(
"Initializing Gherkin (Cucumber BDD) for CodeceptJS"
);
stdout.should.include(
`Created ${dir}, place your *.feature files in it`
);
stdout.should.include(
"Created sample feature file: features/basic.feature"
);

dir = path.join(codecept_dir_test, "step_definitions");
stdout.should.include(
`Created ${dir}, place step definitions into it`
);
stdout.should.include(
`Created sample steps file: step_definitions/steps.${extension}`
);
assert(!err);

const configResult = fs
.readFileSync(
path.join(codecept_dir_test, `codecept.conf.${extension}`)
)
.toString();
configResult.should.contain(`features: './features/*.feature'`);
configResult.should.contain(
`steps: ['./step_definitions/steps.${extension}']`
);
done();
});
});
});
});
});
Loading