actions/git-backporting
1
0
Fork 0
mirror of https://code.forgejo.org/actions/git-backporting.git synced 2025-05-18 03:29:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: updated logging messages (#65)

Browse source
This commit is contained in:
Andrea Lamparelli 2023-07-20 10:05:07 +02:00 • committed by GitHub
parent e29dae5073
commit a8db0755a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 88 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/service/configs/configs-parser.ts
View file

@ -24,12 +24,12 @@ import LoggerServiceFactory from "../logger/logger-service-factory";
// if pr is opened check if the there exists one single commit
if (configs.originalPullRequest.state == "open") {
this.logger.warn("Trying to backport an open pull request!");
this.logger.warn("Trying to backport an open pull request");
}
// if PR is closed and not merged log a warning
// if PR is closed and not merged throw an error
if (configs.originalPullRequest.state == "closed" && !configs.originalPullRequest.merged) {
throw new Error("Provided pull request is closed and not merged!");
throw new Error("Provided pull request is closed and not merged");
}
return Promise.resolve(configs);

12
src/service/git/git-cli.ts
View file

@ -60,7 +60,7 @@ export default class GitCLIService {
* @param branch branch which should be cloned
*/
async clone(from: string, to: string, branch: string): Promise<void> {
this.logger.info(`Cloning repository ${from} to ${to}.`);
this.logger.info(`Cloning repository ${from} to ${to}`);
if (!fs.existsSync(to)) {
await simpleGit().clone(this.remoteWithAuth(from), to, ["--quiet", "--shallow-submodules", "--no-tags", "--branch", branch]);
} else {
@ -74,7 +74,7 @@ export default class GitCLIService {
* @param newBranch new branch name
*/
async createLocalBranch(cwd: string, newBranch: string): Promise<void> {
this.logger.info(`Creating branch ${newBranch}.`);
this.logger.info(`Creating branch ${newBranch}`);
await this.git(cwd).checkoutLocalBranch(newBranch);
}
@ -85,7 +85,7 @@ export default class GitCLIService {
* @param remoteName [optional] name of the remote, by default 'fork' is used
*/
async addRemote(cwd: string, remote: string, remoteName = "fork"): Promise<void> {
this.logger.info(`Adding new remote ${remote}.`);
this.logger.info(`Adding new remote ${remote}`);
await this.git(cwd).addRemote(remoteName, this.remoteWithAuth(remote));
}
@ -96,7 +96,7 @@ export default class GitCLIService {
* @param remote [optional] the remote to fetch, by default origin
*/
async fetch(cwd: string, branch: string, remote = "origin"): Promise<void> {
this.logger.info(`Fetching ${remote} ${branch}.`);
this.logger.info(`Fetching ${remote} ${branch}`);
await this.git(cwd).fetch(remote, branch, ["--quiet"]);
}
@ -106,7 +106,7 @@ export default class GitCLIService {
* @param sha commit sha
*/
async cherryPick(cwd: string, sha: string, strategy = "recursive", strategyOption = "theirs"): Promise<void> {
this.logger.info(`Cherry picking ${sha}.`);
this.logger.info(`Cherry picking ${sha}`);
const options = ["cherry-pick", "-m", "1", `--strategy=${strategy}`, `--strategy-option=${strategyOption}`, sha];
try {
@ -128,7 +128,7 @@ export default class GitCLIService {
* @param remote [optional] remote to which the branch should be pushed to, by default 'origin'
*/
async push(cwd: string, branch: string, remote = "origin", force = false): Promise<void> {
this.logger.info(`Pushing ${branch} to ${remote}.`);
this.logger.info(`Pushing ${branch} to ${remote}`);
const options = ["--quiet"];
if (force) {

8
src/service/git/git-client-factory.ts
View file

@ -13,9 +13,10 @@ export default class GitClientFactory {
private static logger: LoggerService = LoggerServiceFactory.getLogger();
private static instance?: GitClient;
// this method assumes there already exists a singleton client instance, otherwise it will fail
public static getClient(): GitClient {
if (!GitClientFactory.instance) {
throw new Error("You must call `getOrCreate` method first!");
throw new Error("You must call `getOrCreate` method first");
}
return GitClientFactory.instance;
@ -29,7 +30,7 @@ export default class GitClientFactory {
public static getOrCreate(type: GitClientType, authToken: string | undefined, apiUrl: string): GitClient {
if (GitClientFactory.instance) {
GitClientFactory.logger.warn("Git service already initialized!");
GitClientFactory.logger.warn("Git service already initialized");
return GitClientFactory.instance;
}
@ -49,8 +50,9 @@ export default class GitClientFactory {
return GitClientFactory.instance;
}
// this is used for testing purposes
public static reset(): void {
GitClientFactory.logger.warn("Resetting git service!");
GitClientFactory.logger.warn("Resetting git service");
GitClientFactory.instance = undefined;
}
}

4
src/service/git/github/github-client.ts
View file

@ -32,7 +32,7 @@ export default class GitHubClient implements GitClient {
}
async getPullRequest(owner: string, repo: string, prNumber: number, squash = true): Promise<GitPullRequest> {
this.logger.info(`Getting pull request ${owner}/${repo}/${prNumber}.`);
this.logger.debug(`Fetching pull request ${owner}/${repo}/${prNumber}`);
const { data } = await this.octokit.rest.pulls.get({
owner: owner,
repo: repo,
@ -66,7 +66,7 @@ export default class GitHubClient implements GitClient {
// WRITE
async createPullRequest(backport: BackportPullRequest): Promise<string> {
this.logger.info(`Creating pull request ${backport.head} -> ${backport.base}.`);
this.logger.info(`Creating pull request ${backport.head} -> ${backport.base}`);
this.logger.info(`${JSON.stringify(backport, null, 2)}`);
const { data } = await this.octokit.pulls.create({

1
src/service/git/github/octokit-factory.ts
View file

@ -12,7 +12,6 @@ export default class OctokitFactory {
public static getOctokit(token: string | undefined, apiUrl: string): Octokit {
if (!OctokitFactory.octokit) {
OctokitFactory.logger.info("Creating octokit instance.");
OctokitFactory.octokit = new Octokit({
auth: token,
userAgent: "kiegroup/git-backporting",

2
src/service/git/gitlab/gitlab-client.ts
View file

@ -69,7 +69,7 @@ export default class GitLabClient implements GitClient {
// WRITE
async createPullRequest(backport: BackportPullRequest): Promise<string> {
this.logger.info(`Creating pull request ${backport.head} -> ${backport.base}.`);
this.logger.info(`Creating pull request ${backport.head} -> ${backport.base}`);
this.logger.info(`${JSON.stringify(backport, null, 2)}`);
const projectId = this.getProjectId(backport.owner, backport.repo);

10
src/service/logger/console-logger-service.ts
View file

@ -12,25 +12,25 @@ export default class ConsoleLoggerService implements LoggerService {
}
trace(message: string): void {
this.logger.log("[TRACE]", message);
this.logger.log("TRACE", message);
}
debug(message: string): void {
if (this.verbose) {
this.logger.log("[DEBUG]", message);
this.logger.log("DEBUG", message);
}
}
info(message: string): void {
this.logger.log("[INFO]", message);
this.logger.log("INFO", message);
}
warn(message: string): void {
this.logger.log("[WARN]", message);
this.logger.log("WARN", message);
}
error(message: string): void {
this.logger.log("[ERROR]", message);
this.logger.log("ERROR", message);
}
}

2
src/service/logger/logger.ts
View file

@ -6,7 +6,7 @@
log(prefix: string, ...str: string[]) {
// eslint-disable-next-line no-console
console.log.apply(console, [prefix, ...str]);
console.log.apply(console, [`[${prefix.padEnd(5)}]`, ...str]);
}
emptyLine() {

8
src/service/runner/runner.ts
View file

@ -30,13 +30,13 @@ export default class Runner {
try {
await this.execute();
this.logger.info("Process succeeded!");
this.logger.info("Process succeeded");
process.exit(0);
} catch (error) {
this.logger.error(`${error}`);
this.logger.info("Process failed!");
this.logger.info("Process failed");
process.exit(1);
}
}
@ -50,7 +50,7 @@ export default class Runner {
const args: Args = this.argsParser.parse();
if (args.dryRun) {
this.logger.warn("Dry run enabled!");
this.logger.warn("Dry run enabled");
}
// 2. init git service
@ -123,7 +123,7 @@ export default class Runner {
this.logger.info(`Pull request created: ${prUrl}`);
} else {
this.logger.warn("Pull request creation and remote push skipped!");
this.logger.warn("Pull request creation and remote push skipped");
this.logger.info(`${JSON.stringify(backport, null, 2)}`);
}
}