Skip to content

Test/dry convert rules 142 #213

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 6, 2019
Merged

Test/dry convert rules 142 #213

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
807e57e
refactor (test): Extract creation of sample ts-lint rule into function
Oct 6, 2019
1fff23f
refactor (test): Extract the setup of the conversion environment into…
Oct 6, 2019
2426714
refactor (test): Add better types to Maps
Oct 6, 2019
17963b5
refactor (test): Extract parametrized converter and merger creation i…
Oct 6, 2019
1781813
Merge branch 'master' into test/dry-convert-rules_142
Oct 6, 2019
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
148 changes: 79 additions & 69 deletions src/rules/convertRules.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
import { ConversionError } from "../errors/conversionError";
import { convertRules } from "./convertRules";
import { TSLintRuleOptions } from "./types";
import { TSLintRuleOptions, TSLintRuleSeverity } from "./types";
import { RuleConverter, ConversionResult } from "./converter";
import { RuleMerger } from "./merger";

describe("convertRules", () => {
it("doesn't marks a disabled rule as missing when its converter returns undefined", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
const { tslintRule, converters, mergers } = setupConversionEnvironment({
ruleSeverity: "off",
};
const converters = new Map();
const mergers = new Map();
});

// Act
const { missing } = convertRules(
Expand All @@ -25,13 +23,7 @@ describe("convertRules", () => {

it("marks an enabled rule as missing when its converter returns undefined", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const converters = new Map();
const mergers = new Map();
const { tslintRule, converters, mergers } = setupConversionEnvironment();

// Act
const { missing } = convertRules(
Expand All @@ -45,14 +37,9 @@ describe("convertRules", () => {

it("marks a conversion as failed when returned a conversion error", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const { tslintRule, converters, mergers } = setupConversionEnvironment();
const conversionError = ConversionError.forRuleError(new Error(), tslintRule);
const converters = new Map([[tslintRule.ruleName, () => conversionError]]);
const mergers = new Map();
converters.set(tslintRule.ruleName, () => conversionError);

// Act
const { failed } = convertRules(
Expand All @@ -66,20 +53,16 @@ describe("convertRules", () => {

it("marks a converted rule name as converted when a conversion has rules", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
ruleName: "eslint-rule-a",
},
],
};
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map();
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
});

// Act
const { converted } = convertRules(
Expand All @@ -103,11 +86,6 @@ describe("convertRules", () => {

it("reports a failure when two outputs exist for a converted rule without a merger", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
Expand All @@ -118,8 +96,9 @@ describe("convertRules", () => {
},
],
};
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map();
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
});

// Act
const { failed } = convertRules(
Expand All @@ -133,11 +112,6 @@ describe("convertRules", () => {

it("merges rule arguments two outputs exist for a converted rule with a merger", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
Expand All @@ -148,9 +122,10 @@ describe("convertRules", () => {
},
],
};
const mergedArguments = [{ merged: true }];
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map([[conversionResult.rules[0].ruleName, () => mergedArguments]]);
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
ruleToMerge: conversionResult.rules[0].ruleName,
});

// Act
const { converted } = convertRules(
Expand All @@ -164,7 +139,7 @@ describe("convertRules", () => {
[
"eslint-rule-a",
{
ruleArguments: mergedArguments,
ruleArguments: [{ merged: true }],
ruleName: "eslint-rule-a",
ruleSeverity: "error",
notices: [],
Expand All @@ -176,11 +151,6 @@ describe("convertRules", () => {

it("merges and deduplicates rule notices", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
Expand All @@ -193,9 +163,10 @@ describe("convertRules", () => {
},
],
};
const mergedArguments = [{ merged: true }];
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map([[conversionResult.rules[0].ruleName, () => mergedArguments]]);
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
ruleToMerge: conversionResult.rules[0].ruleName,
});

// Act
const { converted } = convertRules(
Expand All @@ -209,7 +180,7 @@ describe("convertRules", () => {
[
"eslint-rule-a",
{
ruleArguments: mergedArguments,
ruleArguments: [{ merged: true }],
ruleName: "eslint-rule-a",
ruleSeverity: "error",
notices: ["notice-1", "notice-2"],
Expand All @@ -221,11 +192,6 @@ describe("convertRules", () => {

it("merges undefined notices", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
Expand All @@ -238,9 +204,10 @@ describe("convertRules", () => {
},
],
};
const mergedArguments = [{ merged: true }];
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map([[conversionResult.rules[0].ruleName, () => mergedArguments]]);
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
ruleToMerge: conversionResult.rules[0].ruleName,
});

// Act
const { converted } = convertRules(
Expand All @@ -254,7 +221,7 @@ describe("convertRules", () => {
[
"eslint-rule-a",
{
ruleArguments: mergedArguments,
ruleArguments: [{ merged: true }],
ruleName: "eslint-rule-a",
ruleSeverity: "error",
notices: [],
Expand All @@ -266,17 +233,13 @@ describe("convertRules", () => {

it("marks a new plugin when a conversion has a new plugin", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
plugins: ["extra-plugin"],
rules: [],
};
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map();
const { tslintRule, converters, mergers } = setupConversionEnvironment({
conversionResult,
});

// Act
const { plugins } = convertRules(
Expand All @@ -288,3 +251,50 @@ describe("convertRules", () => {
expect(plugins).toEqual(new Set(["extra-plugin"]));
});
});

function setupConversionEnvironment(
config: {
ruleSeverity?: TSLintRuleSeverity;
conversionResult?: ConversionResult;
ruleToMerge?: string;
} = {},
) {
const { ruleSeverity, conversionResult, ruleToMerge } = config;

const tslintRule = createSampleTsLintRule(ruleSeverity);
const converters = createConverters(tslintRule, conversionResult);
const mergers = createMergers(ruleToMerge);

return { tslintRule, converters, mergers };
}

function createSampleTsLintRule(ruleSeverity: TSLintRuleSeverity = "error"): TSLintRuleOptions {
return {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity,
};
}

function createConverters(
tslintRule: TSLintRuleOptions,
conversionResult?: ConversionResult,
): Map<string, RuleConverter> {
const converters = new Map<string, RuleConverter>();

if (conversionResult !== undefined) {
converters.set(tslintRule.ruleName, () => conversionResult);
}

return converters;
}

function createMergers(ruleToMerge?: string): Map<string, RuleMerger> {
const mergers = new Map<string, RuleMerger>();

if (ruleToMerge !== undefined) {
mergers.set(ruleToMerge, () => [{ merged: true }]);
}

return mergers;
}