fix; files that didn't backed up is not removed in "post" phase (#256)

* fix; files that didn't backed up is not removed in "post" phase

* output logs

* output log in main phase

* update log text

* update log text

* create directory only if not exist

* amend step name

.github/workflows/reusable-verify.yml

@@ -162,7 +162,7 @@ jobs:
       with:
         key: "dummy" # replaced
         known_hosts: unnecessary
-    - name: Install SSH key (replace)
+    - name: Install SSH key (replaces existing key)
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}
@@ -181,7 +181,7 @@ jobs:
       if: ${{ inputs.package_installation_command != '' }}
     - name: Checkout source codes
       uses: actions/checkout@v3
-    - name: Install SSH key (replace)
+    - name: Install SSH key
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}
@@ -200,12 +200,12 @@ jobs:
       if: ${{ inputs.package_installation_command != '' }}
     - name: Checkout source codes
       uses: actions/checkout@v3
-    - name: Install SSH key (dummy)
+    - name: Install SSH key
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}
         known_hosts: unnecessary
-    - name: Install SSH key (replace)
+    - name: Install SSH key (does nothing)
       uses: ./.
       with:
         key: "dummy" # ignored
@@ -224,7 +224,7 @@ jobs:
       if: ${{ inputs.package_installation_command != '' }}
     - name: Checkout source codes
       uses: actions/checkout@v3
-    - name: Install SSH key (replace)
+    - name: Install SSH key
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}
@@ -243,15 +243,15 @@ jobs:
       if: ${{ inputs.package_installation_command != '' }}
     - name: Checkout source codes
       uses: actions/checkout@v3
-    - name: Install SSH key (dummy)
+    - name: Install SSH key
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}
         known_hosts: unnecessary
-    - name: Install SSH key (replace)
+    - name: Install SSH key (fails)
       uses: ./.
       with:
-        key: "dummy" # ignored
+        key: "dummy" # fails
         known_hosts: unnecessary
         if_key_exists: fail
       continue-on-error: true
@@ -268,7 +268,7 @@ jobs:
       if: ${{ inputs.package_installation_command != '' }}
     - name: Checkout source codes
       uses: actions/checkout@v3
-    - name: Install SSH key (replace)
+    - name: Install SSH key
       uses: ./.
       with:
         key: ${{ secrets.SSH_KEY_PEM }}

src/common.ts

@@ -6,6 +6,7 @@ import * as core from "@actions/core";
 
 /** state name of backup suffix */
 const STATE_BACKUP_SUFFIX = "backup-suffix";
+const STATE_CREATED_FILES = "created-files";
 
 /**
  * create backup suffix name
@@ -31,6 +32,24 @@ export function getBackupSuffix(): string {
     return core.getState(STATE_BACKUP_SUFFIX);
 }
 
+/**
+ * save created file names
+ * @param fileNames array of file names
+ */
+export function saveCreatedFileNames(fileNames: string[]): void {
+    const json = JSON.stringify(fileNames);
+    core.saveState(STATE_CREATED_FILES, json);
+}
+
+/**
+ * save created file names
+ * @returns saved array of file names
+ */
+export function loadCreatedFileNames(): string[] {
+    const json = core.getState(STATE_CREATED_FILES);
+    return JSON.parse(json) as string[];
+}
+
 /**
  * get SSH directory
  * @returns SSH directory name

src/main.ts

@@ -48,10 +48,10 @@ export function main(): void {
     // create ".ssh" directory
     const sshDirName = common.getSshDirectory();
     const backupSuffix = common.createBackupSuffix(sshDirName);
-    fs.mkdirSync(sshDirName, {
+    if (backupSuffix === "") {
-        recursive: true,
+        createDirectory(sshDirName);
-        mode: 0o700,
+        console.log(`✅SSH directory "${sshDirName}" has been created successfully.`);
-    });
+    }
 
     // files to be created
     const files: FileInfo[] = [
@@ -89,6 +89,7 @@ export function main(): void {
     }
 
     // create files
+    const createdFileNames: string[] = [];
     const backedUpFileNames: string[] = [];
     for (const file of files) {
         const fileName = path.join(sshDirName, file.name);
@@ -97,14 +98,27 @@ export function main(): void {
         }
 
         fs.writeFileSync(fileName, file.contents, file.options);
+        createdFileNames.push(file.name);
     }
+    common.saveCreatedFileNames(createdFileNames);
 
-    console.log(`SSH key has been stored to ${sshDirName} successfully.`);
+    console.log(`✅Following files have been created in "${sshDirName}" successfully; ${createdFileNames.join(", ")}`);
     if (backedUpFileNames.length > 0) {
-        console.log(`Following files are backed up in suffix "${backupSuffix}"; ${backedUpFileNames.join(", ")}`);
+        console.log(`✅Following files have been backed up in suffix "${backupSuffix}" successfully; ${backedUpFileNames.join(", ")}`);
     }
 }
 
+/**
+ * create directory
+ * @param dirName directory name to remove
+ */
+function createDirectory(dirName: string): void {
+    fs.mkdirSync(dirName, {
+        recursive: true,
+        mode: 0o700,
+    });
+}
+
 /**
  * back up file
  * @param fileName file to back up

src/post.ts

@@ -17,35 +17,55 @@ try {
  * cleanup function
  */
 export function post(): void {
+    const sshDirName = common.getSshDirectory();
     const backupSuffix = common.getBackupSuffix();
     if (backupSuffix === "") {
         // remove ".ssh" directory if suffix is not set
-        removeSshDirectory();
+        removeDirectory(sshDirName);
+        console.log(`✅SSH directory "${sshDirName}" has been removed successfully.`);
     } else {
-        // restore files from backup suffix
+        // remove created files and restore from backup
-        restore(backupSuffix);
+        const removedFileNames = removeCreatedFiles(sshDirName);
+        console.log(`✅Following files have been removed successfully; ${removedFileNames.join(", ")}`);
+
+        const restoredFileNames = restoreFiles(sshDirName, backupSuffix);
+        console.log(`✅Following files in suffix "${backupSuffix}" have been restored successfully; ${restoredFileNames.join(", ")}`);
     }
 }
 
 /**
- * remove ".ssh" directory
+ * remove directory
+ * @param dirName directory name to remove
  */
-function removeSshDirectory(): void {
+function removeDirectory(dirName: string): void {
-    const dirName = common.getSshDirectory();
     fs.rmSync(dirName, {
         recursive: true,
         force: true,
     });
+}
 
-    console.log(`SSH key in ${dirName} has been removed successfully.`);
+/**
+ * remove created files in main phase
+ * @param dirName directory name
+ * @returns removed file names
+ */
+function removeCreatedFiles(dirName: string): string[] {
+    const createdFileNames = common.loadCreatedFileNames();
+    for (const fileName of createdFileNames) {
+        const pathName = path.join(dirName, fileName);
+
+        fs.rmSync(pathName);
+    }
+    return createdFileNames;
 }
 
 /**
  * restore files from backups
+ * @param dirName directory name
  * @param backupSuffix suffix of backup directory
+ * @returns restored file names
  */
-function restore(backupSuffix: string): void {
+function restoreFiles(dirName: string, backupSuffix: string): string[] {
-    const dirName = common.getSshDirectory();
     const restoredFileNames: string[] = [];
     const entries = fs.readdirSync(dirName)
         .filter((entry) => {
@@ -58,9 +78,8 @@ function restore(backupSuffix: string): void {
         const pathNameOrg = path.join(dirName, entryOrg);
         const pathNameBak = path.join(dirName, entry);
 
-        fs.rmSync(pathNameOrg);
         fs.renameSync(pathNameBak, pathNameOrg);
         restoredFileNames.push(entryOrg);
     }
-    console.log(`Following files in suffix "${backupSuffix}" are restored; ${restoredFileNames.join(", ")}`);
+    return restoredFileNames;
 }