diff --git a/.gitignore b/.gitignore
index 6676302..d42022e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -128,3 +128,39 @@ out
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
+
+pubspec.lock
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+build/
+
+
diff --git a/README.md b/README.md
index 145fe22..b3ee144 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
# flutter-code-quality
-An action that runs on PRs to format and test Flutter repos.
+This action is designed to format and test Flutter repositories on pull requests. It helps ensure that your code meets the required quality standards.
### Usage
+Follow the instructions below to integrate this action into your workflow.
+
```yml
name: Pull Request
-
on:
pull_request:
@@ -14,14 +15,20 @@ jobs:
code-quality:
runs-on: ubuntu-latest
steps:
+ # Checkout branch
- uses: actions/checkout@v4
- with:
- repository: ${{github.event.pull_request.head.repo.full_name}}
- ref: ${{ github.head_ref }}
+ # Set up Flutter within the action
- uses: subosito/flutter-action@v2
- with:
- cache: true
- uses: ZebraDevs/flutter-code-quality@main
with:
+ # Token used for authentication.
token: ${{secrets.GITHUB_TOKEN}}
```
+
+## Contributing
+
+This project welcomes contributions. Pleae check out our [Contributing guide](CONTRIBUTING.md) to learn more on how to get started.
+
+### License
+
+This project is released under the [MIT License](./LICENSE).
diff --git a/dist/index.js b/dist/index.js
index 8a53ad7..3ca252b 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -30419,15 +30419,17 @@ function wrappy (fn, cb) {
/***/ }),
-/***/ 7890:
+/***/ 798:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getAnalyze = void 0;
+exports.generateTableRow = exports.getErrEmoji = exports.getAnalyze = exports.ANALYZE_FAILURE = exports.ANALYZE_SUCCESS = void 0;
const exec_1 = __nccwpck_require__(2259);
const core_1 = __nccwpck_require__(2614);
+exports.ANALYZE_SUCCESS = "✅ - Static analysis passed";
+exports.ANALYZE_FAILURE = "⛔️ - Static analysis failed";
const getAnalyze = async () => {
(0, core_1.startGroup)("Analyzing code");
let response;
@@ -30438,7 +30440,7 @@ const getAnalyze = async () => {
stdout: (data) => (stdout += data.toString()),
},
});
- response = { output: "✅ - Static analysis passed", error: false };
+ response = { output: exports.ANALYZE_SUCCESS, error: false };
}
catch (error) {
const arr = stdout.trim().split("\n");
@@ -30464,11 +30466,11 @@ const getAnalyze = async () => {
}
return;
});
- const errorString = errors.map((e) => generateTableRow(e, "error"));
- const warningString = warnings.map((e) => generateTableRow(e, "warning"));
- const infoString = infos.map((e) => generateTableRow(e, "info"));
+ const errorString = errors.map((e) => (0, exports.generateTableRow)(e, "error"));
+ const warningString = warnings.map((e) => (0, exports.generateTableRow)(e, "warning"));
+ const infoString = infos.map((e) => (0, exports.generateTableRow)(e, "info"));
const issuesFound = arr.at(-1);
- const output = `⛔️ - Static analysis failed; ${issuesFound}
+ const output = `${exports.ANALYZE_FAILURE}; ${issuesFound}
See details
| Type | File name | Details |
|---|
${errorString.join("")}${warningString.join("")}${infoString.join("")}
| ${getErrEmoji(type)} | Error | ${err.file} | ${err.details} |
`;
+exports.getErrEmoji = getErrEmoji;
+const generateTableRow = (err, type) => `| ${(0, exports.getErrEmoji)(type)} | Error | ${err.file} | ${err.details} |
`;
+exports.generateTableRow = generateTableRow;
/***/ }),
-/***/ 8058:
+/***/ 8890:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
@@ -30543,7 +30547,7 @@ exports.checkBranchStatus = checkBranchStatus;
/***/ }),
-/***/ 9498:
+/***/ 369:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
@@ -30616,16 +30620,17 @@ async function postComment(octokit, commentMessage, context) {
/***/ }),
-/***/ 7661:
+/***/ 5499:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getOldCoverage = exports.getCoverage = void 0;
+exports.getOldCoverage = exports.getCoverage = exports.COV_FAILURE = void 0;
const lcov_utils_1 = __nccwpck_require__(1641);
const node_fs_1 = __nccwpck_require__(7561);
const core_1 = __nccwpck_require__(2614);
+exports.COV_FAILURE = "⚠️ - Coverage check failed";
const getCoverage = (oldCoverage) => {
(0, core_1.startGroup)("Checking test coverage");
let response;
@@ -30643,10 +30648,10 @@ const getCoverage = (oldCoverage) => {
});
if (oldCoverage != undefined) {
if (oldCoverage > totalPercent) {
- percentOutput = totalPercent + `% (🔻 down from ` + oldCoverage + `)`;
+ percentOutput = totalPercent + `% (🔻 down from ` + oldCoverage + `%)`;
}
else if (oldCoverage < totalPercent) {
- percentOutput = totalPercent + `% (👆 up from ` + oldCoverage + `)`;
+ percentOutput = totalPercent + `% (⬆️ up from ` + oldCoverage + `%)`;
}
else {
percentOutput = totalPercent + `% (no change)`;
@@ -30663,15 +30668,11 @@ const getCoverage = (oldCoverage) => {
${arr.join("")}
`;
- return { output: str, error: false };
+ response = { output: str, error: false };
}
catch (error) {
- response = { output: "⚠️ - Coverage check failed", error: true };
- }
- finally {
- if (response == undefined) {
- response = { output: "⚠️ - Coverage check failed", error: true };
- }
+ console.error("Error checking coverage", error);
+ response = { output: exports.COV_FAILURE, error: true };
}
(0, core_1.endGroup)();
return response;
@@ -30697,7 +30698,7 @@ exports.getOldCoverage = getOldCoverage;
/***/ }),
-/***/ 7523:
+/***/ 3662:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
@@ -30744,112 +30745,92 @@ exports.push = push;
/***/ }),
-/***/ 7046:
+/***/ 9054:
/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.setup = void 0;
-const core_1 = __nccwpck_require__(2614);
-const exec_1 = __nccwpck_require__(2259);
-const setup = async () => {
- (0, core_1.startGroup)("Set up Flutter");
- try {
- await (0, exec_1.exec)("flutter pub get");
- await (0, exec_1.exec)("dart format . -l 120");
- await (0, exec_1.exec)("dart fix --apply");
- }
- catch (e) {
- console.error("Error during flutter setup", e);
- }
- (0, core_1.endGroup)();
-};
-exports.setup = setup;
-
-
-/***/ }),
-
-/***/ 3390:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getTest = void 0;
+exports.getTest = exports.TEST_ERROR = exports.TEST_SUCCESS = void 0;
const core_1 = __nccwpck_require__(2614);
const exec_1 = __nccwpck_require__(2259);
+exports.TEST_SUCCESS = "✅ - All tests passed";
+exports.TEST_ERROR = "⚠️ - Error running tests";
const getTest = async () => {
(0, core_1.startGroup)("Running tests");
let response;
let stdout = "";
+ let stderr = "";
try {
await (0, exec_1.exec)("flutter test --coverage --reporter json", [], {
listeners: {
stdout: (data) => (stdout += data.toString()),
+ stderr: (data) => (stderr += data.toString()),
},
});
- response = { output: "✅ - All tests passed", error: false };
+ response = { output: exports.TEST_SUCCESS, error: false };
}
catch (error) {
- const objStr = "[" + stdout.split("\n").join(",").slice(0, -1) + "]";
- const obj = JSON.parse(objStr);
- let failIds = [];
- obj.forEach((element) => {
- if (element.type == "testDone" &&
- element.result.toLowerCase() == "error") {
- failIds.push(element.testID);
- }
- });
- let initialString = "";
- if (failIds.length > 1) {
- initialString = `${failIds.length} tests failed`;
- }
- else if (failIds.length == 1) {
- initialString = `${failIds.length} test failed`;
- }
- const errorString = [];
- failIds.forEach((e1) => {
- const allEntries = obj.filter((e) => (e.hasOwnProperty("testID") && e.testID == e1) ||
- (e.hasOwnProperty("test") &&
- e.test.hasOwnProperty("id") &&
- e.test.id == e1));
- const entry1 = allEntries.find((e) => e.hasOwnProperty("test") && e.test.hasOwnProperty("id"));
- let testName = "Error getting test name";
- if (entry1) {
- testName = entry1.test.name.split("/test/").slice(-1);
- }
- const entry2 = allEntries.find((e) => e.hasOwnProperty("stackTrace") && e.stackTrace.length > 1);
- const entry3 = allEntries.find((e) => e.hasOwnProperty("message") &&
- e.message.length > 1 &&
- e.message.includes("EXCEPTION CAUGHT BY FLUTTER"));
- const entry4 = allEntries.find((e) => e.hasOwnProperty("error") && e.error.length > 1);
- let testDetails = "Unable to get test details. Run flutter test to replicate";
- if (entry2) {
- testDetails = entry2.stackTrace;
- }
- else if (entry3) {
- testDetails = entry3.message;
+ if (!stderr.includes('Test directory "test" not found.')) {
+ const objStr = "[" + stdout.split("\n").join(",").slice(0, -1) + "]";
+ const obj = JSON.parse(objStr);
+ let failIds = [];
+ obj.forEach((element) => {
+ if (element.type == "testDone" &&
+ element.result.toLowerCase() == "error") {
+ failIds.push(element.testID);
+ }
+ });
+ let initialString = "";
+ if (failIds.length > 1) {
+ initialString = `${failIds.length} tests failed`;
}
- else if (entry4) {
- testDetails = entry4.error;
+ else if (failIds.length == 1) {
+ initialString = `${failIds.length} test failed`;
}
- errorString.push("" +
- testName +
- "
`" +
- testDetails +
- "`" +
+ testName +
+ "
`" +
+ testDetails +
+ "`See details
${errorString.join("")}
See details
| Type | File name | Details |
|---|
${errorString.join(
@@ -69,7 +72,7 @@ export const getAnalyze = async (): Promise => {
return response;
};
-const getErrEmoji = (errType: analyzeErrTypes) => {
+export const getErrEmoji = (errType: analyzeErrTypes) => {
switch (errType) {
case "error":
return "⛔️";
@@ -80,7 +83,7 @@ const getErrEmoji = (errType: analyzeErrTypes) => {
}
};
-const generateTableRow = (err: analyzeDetails, type: analyzeErrTypes) =>
+export const generateTableRow = (err: analyzeDetails, type: analyzeErrTypes) =>
`| ${getErrEmoji(type)} | Error | ${err.file} | ${
err.details
} |
`;
diff --git a/src/behind.ts b/src/scripts/behind.ts
similarity index 97%
rename from src/behind.ts
rename to src/scripts/behind.ts
index 0cdd5e4..a8fe247 100644
--- a/src/behind.ts
+++ b/src/scripts/behind.ts
@@ -1,7 +1,7 @@
import { endGroup, startGroup } from "@actions/core";
import { Context } from "@actions/github/lib/context";
import { GitHub } from "@actions/github/lib/utils";
-import { stepResponse } from "./main";
+import { stepResponse } from "../main";
export const checkBranchStatus = async (
octokit: InstanceType,
diff --git a/src/comment.ts b/src/scripts/comment.ts
similarity index 98%
rename from src/comment.ts
rename to src/scripts/comment.ts
index c7f0db9..d3e77da 100644
--- a/src/comment.ts
+++ b/src/scripts/comment.ts
@@ -1,7 +1,7 @@
import { endGroup, startGroup } from "@actions/core";
import { Context } from "@actions/github/lib/context";
import { GitHub } from "@actions/github/lib/utils";
-import { stepResponse } from "./main";
+import { stepResponse } from "../main";
const SIGNATURE = `Created with Flutter code quality action`;
diff --git a/src/coverage.ts b/src/scripts/coverage.ts
similarity index 83%
rename from src/coverage.ts
rename to src/scripts/coverage.ts
index fa308ee..e3a7a4a 100644
--- a/src/coverage.ts
+++ b/src/scripts/coverage.ts
@@ -1,8 +1,9 @@
import { Lcov, LcovDigest, parse, sum } from "lcov-utils";
import { readFileSync } from "node:fs";
import { endGroup, startGroup } from "@actions/core";
-import { stepResponse } from "./main";
+import { stepResponse } from "../main";
+export const COV_FAILURE = "⚠️ - Coverage check failed";
export const getCoverage = (oldCoverage: number | undefined): stepResponse => {
startGroup("Checking test coverage");
let response: stepResponse | undefined;
@@ -23,9 +24,9 @@ export const getCoverage = (oldCoverage: number | undefined): stepResponse => {
if (oldCoverage != undefined) {
if (oldCoverage > totalPercent) {
- percentOutput = totalPercent + `% (🔻 down from ` + oldCoverage + `)`;
+ percentOutput = totalPercent + `% (🔻 down from ` + oldCoverage + `%)`;
} else if (oldCoverage < totalPercent) {
- percentOutput = totalPercent + `% (👆 up from ` + oldCoverage + `)`;
+ percentOutput = totalPercent + `% (⬆️ up from ` + oldCoverage + `%)`;
} else {
percentOutput = totalPercent + `% (no change)`;
}
@@ -41,13 +42,10 @@ export const getCoverage = (oldCoverage: number | undefined): stepResponse => {
${arr.join("")}
" +
+ testName +
+ "
`" +
+ testDetails +
+ "`See details
+ ${errorString.join("")}
+ " +
- testName +
- "
`" +
- testDetails +
- "`See details
- ${errorString.join("")}
- | ⛔️ | Error | ${errorDetails.file} | ${errorDetails.details} |
`
+ );
+ expect(warningTableRow).toBe(
+ `| ⚠️ | Error | ${warningDetails.file} | ${warningDetails.details} |
`
+ );
+ expect(infoTableRow).toBe(
+ `| ℹ️ | Error | ${infoDetails.file} | ${infoDetails.details} |
`
+ );
+}, 30000);
diff --git a/tests/src/scripts/coverage.test.ts b/tests/src/scripts/coverage.test.ts
new file mode 100644
index 0000000..483da12
--- /dev/null
+++ b/tests/src/scripts/coverage.test.ts
@@ -0,0 +1,86 @@
+import { exec, execSync } from "child_process";
+import { stepResponse } from "../../../src/main";
+import {
+ COV_FAILURE,
+ getCoverage,
+ getOldCoverage,
+} from "../../../src/scripts/coverage";
+const oldCoverage = 83.33;
+
+test("should return stepResponse object", () => {
+ const oldCoverage = 80;
+ const result: stepResponse = getCoverage(oldCoverage);
+ expect(result).toEqual(
+ expect.objectContaining({
+ error: expect.any(Boolean),
+ output: expect.any(String),
+ })
+ );
+});
+
+test("coverage decrease", () => {
+ process.chdir("tests/pass_repo");
+ execSync("flutter test --coverage");
+
+ const oldCoverage = 95;
+ const result: stepResponse = getCoverage(oldCoverage);
+
+ expect(result.output.includes(" (🔻 down from 95%)")).toBe(true);
+
+ process.chdir("../..");
+});
+
+test("coverage increase", () => {
+ process.chdir("tests/pass_repo");
+
+ const oldCoverage = 5;
+ const result: stepResponse = getCoverage(oldCoverage);
+
+ expect(result.output.includes(" (⬆️ up from 5%)")).toBe(true);
+
+ process.chdir("../..");
+});
+
+test("coverage same", () => {
+ process.chdir("tests/pass_repo");
+
+ const result: stepResponse = getCoverage(oldCoverage);
+ expect(result.output.includes(" (no change)")).toBe(true);
+
+ process.chdir("../..");
+});
+
+test("no old coverage", () => {
+ process.chdir("tests/pass_repo");
+
+ const result: stepResponse = getCoverage(undefined);
+ expect(result.output.includes(" (🔻 down from 95%)")).toBe(false);
+ expect(result.output.includes(" (⬆️ up from 5%)")).toBe(false);
+ expect(result.output.includes(" (no change)")).toBe(false);
+
+ process.chdir("../..");
+});
+
+test("fail", () => {
+ process.chdir("tests/fail_repo");
+ const result: stepResponse = getCoverage(undefined);
+ console.log(result);
+ expect(result.error).toBe(true);
+ expect(result.output).toEqual(COV_FAILURE);
+ process.chdir("../..");
+});
+
+test("oldCoverage fail", () => {
+ process.chdir("tests/fail_repo");
+
+ const result = getOldCoverage();
+ expect(result).toEqual(undefined);
+ process.chdir("../..");
+});
+test("oldCoverage pass", () => {
+ process.chdir("tests/pass_repo");
+
+ const result = getOldCoverage();
+ expect(result).toEqual(oldCoverage);
+ process.chdir("../..");
+});
diff --git a/tests/src/scripts/runTests.test.ts b/tests/src/scripts/runTests.test.ts
new file mode 100644
index 0000000..a0a48e5
--- /dev/null
+++ b/tests/src/scripts/runTests.test.ts
@@ -0,0 +1,32 @@
+import {
+ getTest,
+ TEST_ERROR,
+ TEST_SUCCESS,
+} from "../../../src/scripts/runTests";
+
+test("all tests pass", async () => {
+ process.chdir("tests/pass_repo");
+ const result = await getTest();
+
+ expect(result.error).toBe(false);
+ expect(result.output).toEqual(TEST_SUCCESS);
+
+ process.chdir("../..");
+}, 30000);
+
+test("no tests pass", async () => {
+ process.chdir("tests/fail_repo");
+ const result = await getTest();
+
+ expect(result.error).toBe(true);
+ expect(result.output.includes("⛔️ -")).toBe(true);
+
+ process.chdir("../..");
+}, 30000);
+
+test("no tests to run", async () => {
+ const result = await getTest();
+
+ expect(result.error).toBe(true);
+ expect(result.output).toEqual(TEST_ERROR);
+}, 30000);