Add delete functionality (#2)

* Add delete functionality

* Add checkout to e2e job

* Add dist

Author: Dylan700

.github/workflows/ci.yaml

@@ -7,7 +7,7 @@ on:
     branches: [ master ]
 
 jobs:
-  test:
+  test-unit:
 
     runs-on: ubuntu-latest
 
@@ -23,6 +23,11 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: yarn
       - run: yarn test
+
+  test-e2e:
+     runs-on: ubuntu-latest
+     steps:
+      - uses: actions/checkout@v3
       - run: docker compose up -d
         env: 
           PUBLIC_KEY: ${{secrets.PUBLIC_KEY}}
@@ -48,7 +53,7 @@ jobs:
       - run: ./tests/e2e/verify-basic.sh
         shell: bash
 
-      # Basic Test with Password Login
+      # Basic Test with Password Login, and Delete
       - run: ./tests/e2e/setup.sh
         env: 
          PRIVATE_KEY: ${{secrets.PRIVATE_KEY}}
@@ -64,5 +69,6 @@ jobs:
             ./dist/ => ./dist/
           ignore: |
             *.txt
+          delete: 'true'
       - run: ./tests/e2e/verify-basic.sh
         shell: bash

README.md

@@ -29,6 +29,7 @@ This action uploads files to a remote server using the SFTP protocol. Unlike oth
 | uploads | true | The folders to upload. In the format of `folder/ => upload_folder/`
 | ignore | false | A list of glob patterns for files that should be ignored. (Like the patterns you would find in .gitignore)
 | dry-run | false | If true, outputs the results of the upload, without actually uploading. |
+| delete | false | If true, any existing files in the remote upload directories are deleted. |
 
 ## Examples
 
@@ -77,5 +78,22 @@ with:
     ./src/ => ./www/src/
 ```
 
+### Upload multiples folders and delete existing files in those folders
+
+```yaml
+uses: actions/checkout@v3
+uses: Dylan700/sftp-upload-action@latest
+with:
+  server: sftp.server.com
+  username: jason-bourne
+  key: ${{secrets.key}}
+  passphrase: ${{secrets.passphrase}}
+  port: 22
+  uploads: |
+    ./html/ => ./www/public_html/
+    ./src/ => ./www/src/
+  delete: 'true'
+```
+
 ## Contributions
 Contributions are welcome! If you have something to add or fix, just make a pull request to be reviewed.

action.yml

@@ -34,6 +34,10 @@ inputs:
   ignore:
     description: a list of files to ignore using glob patterns
     required: false
+  delete:
+    description: If true, any existing files in the remote upload directories are deleted.
+    required: false
+    default: 'false'
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -1,4 +1,4 @@
-import { debug, getBooleanInput, getInput, setFailed } from "@actions/core"
+import { debug, getBooleanInput, getInput, setFailed, warning } from "@actions/core"
 import * as Client from "ssh2-sftp-client"
 import Upload from "./types/Upload"
 import minimatch, { MinimatchOptions } from "minimatch"
@@ -43,6 +43,17 @@ function is_uploadable(file: string, patterns: string[]){
 	return !patterns.some(p => minimatch(file, p, minimatch_options))
 }
 
+// recursively delete a remote folder
+async function delete_folder(sftp: Client, dir: string){
+	debug(`Deleting existing files for ${dir}...`)
+	try{
+		await sftp.rmdir(dir, true)
+		debug(`${dir} has been deleted.`)
+	}catch(e: any){
+		warning(`Unable to delete existing files for ${dir} before upload.`)
+	}
+}
+
 async function main(sftp: Client){
 	try {
 		const server: string = getInput("server")
@@ -54,7 +65,7 @@ async function main(sftp: Client){
 		const isDryRun: boolean = getBooleanInput("dry-run")
 		const uploads: Upload[] = parse_uploads(getInput("uploads"))
 		const ignored: string[] = parse_ignored(getInput("ignore"))
-
+		const shouldDelete: boolean = getBooleanInput("delete")
 		debug(`Connecting to ${server} as ${username} on port ${port}`)
 
 		await sftp.connect({
@@ -69,6 +80,7 @@ async function main(sftp: Client){
 		debug("Preparing upload...")
 		for(const upload of uploads) {
 			debug(`Processing ${upload.from} to ${upload.to}`)
+			shouldDelete ? await delete_folder(sftp, upload.to) : null
 			await sftp.uploadDir(upload.from, upload.to, {
 				filter: file => {
 					if(is_uploadable(file, ignored)){
@@ -95,4 +107,4 @@ async function main(sftp: Client){
 	}
 }
 
-export { main, parse_uploads, parse_ignored, is_uploadable }
+export { main, parse_uploads, parse_ignored, is_uploadable, delete_folder }

src/main.ts

@@ -0,0 +1,21 @@
+import { delete_folder } from "../../src/main"
+import Client from "ssh2-sftp-client"
+import * as core from "@actions/core"
+
+jest.mock("ssh2-sftp-client")
+jest.mock("@actions/core")
+
+const sftp = new Client()
+
+describe("delete_folder", () => {
+	it("displays a warning when files cannot be deleted", async () => {
+		sftp.rmdir.mockImplementationOnce(() => {throw new Error("Can't delete")})
+		await delete_folder(sftp, "my_folder/here/")
+		expect(core.warning).toBeCalled()
+	})
+
+	it("attempts to remove the directory recursively", async () => {
+		await delete_folder(sftp, "my_folder/here/")
+		expect(sftp.rmdir).toBeCalledWith("my_folder/here/", true)
+	})
+})

tests/unit/delete_folder.test.ts

@@ -16,7 +16,8 @@ const inputs: any = {
 	"uploads": "here/ => there/",
 	"ignore": "*.yaml",
 	"passphrase": undefined,
-	"key": undefined
+	"key": undefined,
+	"delete": false
 }
 
 const testFiles: string[] = [
@@ -38,6 +39,7 @@ describe("main", () => {
 
 	beforeEach(() => {
 		inputs["dry-run"] = false
+		inputs["delete"] = false
 	})
 
 	it("disconnects from sftp when finished", async () => {
@@ -83,8 +85,19 @@ describe("main", () => {
 	})
 
 	it("calls setFailed if sftp can't connect", async () => {
-		sftp.connect.mockImplementation(() => {throw new Error()})
+		sftp.connect.mockImplementationOnce(() => {throw new Error()})
 		await main(sftp)
 		expect(core.setFailed).toBeCalled()
 	})
+
+	it("uploads folders once", async () => {
+		await main(sftp)
+		expect(sftp.uploadDir).toBeCalledTimes(1)
+	})
+
+	it("attempts to delete existing files when delete is true", async () => {
+		inputs["delete"] = true
+		await main(sftp)
+		expect(sftp.rmdir).toBeCalledTimes(1)
+	})
 })