joplin-plugin-backup 0.5.3 → 1.0.5

package/__test__/help.test.ts

@@ -0,0 +1,74 @@
+import { helper } from "../src/helper";
+
+describe("Test helper", function () {
+  it(`validFileName`, async () => {
+    const testCases = [
+      {
+        fileName: "some test file.txt",
+        expected: true,
+      },
+      {
+        fileName: "some ^test file.txt",
+        expected: true,
+      },
+      {
+        fileName: "some :test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some \\test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some |test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some /test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some *test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some ?test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some <test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some >test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "com9.txt",
+        expected: false,
+      },
+      {
+        fileName: "nul.txt",
+        expected: false,
+      },
+      {
+        fileName: "prn.txt",
+        expected: false,
+      },
+      {
+        fileName: "con.txt",
+        expected: false,
+      },
+      {
+        fileName: "lpt5.txt",
+        expected: false,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      expect(await helper.validFileName(testCase.fileName)).toBe(
+        testCase.expected
+      );
+    }
+  });
+});

package/__test__/pw.test.ts

@@ -0,0 +1,82 @@
+import { Backup } from "../src/Backup";
+import joplin from "api";
+import { when } from "jest-when";
+
+let backup = null;
+
+describe("Password", function () {
+  beforeEach(async () => {
+    backup = new Backup() as any;
+  });
+
+  it(`Check`, async () => {
+    const spyOnsSettingsValue = jest.spyOn(joplin.settings, "value");
+    const spyOnsSettingsSetValue = jest.spyOn(joplin.settings, "setValue");
+
+    const testCases = [
+      {
+        usePassword: false,
+        password: "",
+        passwordRepeat: "",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: false,
+        password: "test",
+        passwordRepeat: "test",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: false,
+        password: "testA",
+        passwordRepeat: "testB",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: "test",
+        passwordRepeat: "test",
+        expected: 1,
+        called: 0,
+      },
+      {
+        usePassword: true,
+        password: "testA",
+        passwordRepeat: "testB",
+        expected: -1,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: " ",
+        passwordRepeat: " ",
+        expected: -1,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: "",
+        passwordRepeat: " ",
+        expected: -1,
+        called: 2,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      /* prettier-ignore */
+      when(spyOnsSettingsValue)
+        .mockImplementation(() => Promise.resolve("no mockImplementation"))
+        .calledWith("usePassword").mockImplementation(() => Promise.resolve(testCase.usePassword))
+        .calledWith("password").mockImplementation(() => Promise.resolve(testCase.password))
+        .calledWith("passwordRepeat").mockImplementation(() => Promise.resolve(testCase.passwordRepeat));
+      expect(await backup.checkPassword()).toBe(testCase.expected);
+
+      await backup.enablePassword();
+      expect(spyOnsSettingsSetValue).toBeCalledTimes(testCase.called);
+      spyOnsSettingsSetValue.mockReset();
+    }
+  });
+});

package/__test__/sevenZip.test.ts

@@ -0,0 +1,102 @@
+import { sevenZip } from "../src/sevenZip";
+import * as path from "path";
+import * as fs from "fs-extra";
+
+const testBaseDir = path.join(__dirname, "ziptests");
+
+describe("Test sevenZip", function () {
+  beforeAll(async () => {});
+
+  beforeEach(async () => {
+    fs.emptyDirSync(testBaseDir);
+  });
+
+  afterAll(async () => {
+    fs.removeSync(testBaseDir);
+  });
+
+  it(`List`, async () => {
+    const file1Name = "file1.txt";
+    const file2Name = "file2.txt";
+    const file3Name = "file3.txt";
+    const file1 = path.join(testBaseDir, file1Name);
+    fs.emptyDirSync(path.join(testBaseDir, "sub"));
+    const file2 = path.join(testBaseDir, "sub", file2Name);
+    const file3 = path.join(testBaseDir, file3Name);
+    const zip = path.join(testBaseDir, "file.7z");
+    fs.writeFileSync(file1, "file");
+    fs.writeFileSync(file2, "file");
+    fs.writeFileSync(file3, "file");
+    expect(fs.existsSync(file1)).toBe(true);
+    expect(fs.existsSync(file2)).toBe(true);
+    expect(fs.existsSync(file3)).toBe(true);
+    expect(fs.existsSync(zip)).toBe(false);
+
+    expect(await sevenZip.add(zip, testBaseDir + "\\*", "secret")).toBe(true);
+    expect(fs.existsSync(zip)).toBe(true);
+
+    expect(await sevenZip.passwordProtected(zip)).toBe(true);
+
+    const fileList = await sevenZip.list(zip, "secret");
+    expect(fileList.length).toBe(4);
+  });
+
+  it(`passwordProtected`, async () => {
+    const fileName = "file.txt";
+    const file = path.join(testBaseDir, fileName);
+    const zipNoPw = path.join(testBaseDir, "nowpw.7z");
+    const zippw = path.join(testBaseDir, "pw.7z");
+
+    fs.writeFileSync(file, "file");
+    expect(fs.existsSync(file)).toBe(true);
+
+    expect(fs.existsSync(zipNoPw)).toBe(false);
+    expect(await sevenZip.add(zipNoPw, file)).toBe(true);
+    expect(fs.existsSync(zipNoPw)).toBe(true);
+    expect(await sevenZip.passwordProtected(zipNoPw)).toBe(false);
+
+    expect(fs.existsSync(zippw)).toBe(false);
+    expect(await sevenZip.add(zippw, file, "secret")).toBe(true);
+    expect(fs.existsSync(zippw)).toBe(true);
+    expect(await sevenZip.passwordProtected(zippw)).toBe(true);
+  });
+
+  describe("Add", function () {
+    it(`File`, async () => {
+      const fileName = "file.txt";
+      const file = path.join(testBaseDir, fileName);
+      const zip = path.join(testBaseDir, "file.7z");
+      fs.writeFileSync(file, "file");
+      expect(fs.existsSync(file)).toBe(true);
+      expect(fs.existsSync(zip)).toBe(false);
+
+      const result = await sevenZip.add(zip, file);
+      expect(result).toBe(true);
+      expect(fs.existsSync(zip)).toBe(true);
+
+      const sevenZipList = await sevenZip.list(zip);
+      expect(sevenZipList.length).toBe(1);
+      expect(sevenZipList[0].file).toBe(fileName);
+    });
+
+    it(`File with password`, async () => {
+      const fileName = "file.txt";
+      const file = path.join(testBaseDir, fileName);
+      const zip = path.join(testBaseDir, "file.7z");
+      const password = "secret";
+      fs.writeFileSync(file, "file");
+      expect(fs.existsSync(file)).toBe(true);
+      expect(fs.existsSync(zip)).toBe(false);
+
+      const result = await sevenZip.add(zip, file, password);
+      expect(result).toBe(true);
+      expect(fs.existsSync(zip)).toBe(true);
+
+      expect(await sevenZip.passwordProtected(zip)).toBe(true);
+
+      const sevenZipList = await sevenZip.list(zip, password);
+      expect(sevenZipList.length).toBe(1);
+      expect(sevenZipList[0].file).toBe(fileName);
+    });
+  });
+});

package/__test__/sevenZipUpdateBinPath.test.ts

@@ -0,0 +1,16 @@
+import { sevenZip, pathTo7zip } from "../src/sevenZip";
+import * as path from "path";
+import joplin from "api";
+
+it(`Set bin from joplin`, async () => {
+  const pathBevor = pathTo7zip;
+  const pathAdd = "addJoplinPath";
+  const pathAfter = path.join(pathAdd, "7zip-bin", pathTo7zip);
+
+  jest.spyOn(joplin.plugins, "installationDir").mockImplementation(async () => {
+    return pathAdd;
+  });
+
+  await sevenZip.updateBinPath();
+  expect(pathTo7zip).toBe(pathAfter);
+});

package/package.json

@@ -1,33 +1,71 @@
-{
-  "name": "joplin-plugin-backup",
-  "version": "0.5.3",
-  "scripts": {
-    "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
-    "prepare": "npm run dist",
-    "update": "npm install -g generator-joplin && yo joplin --update"
-  },
-  "license": "MIT",
-  "keywords": [
-    "joplin-plugin"
-  ],
-  "devDependencies": {
-    "@types/node": "^14.0.14",
-    "chalk": "^4.1.0",
-    "copy-webpack-plugin": "^6.1.0",
-    "fs-extra": "^9.0.1",
-    "glob": "^7.1.6",
-    "on-build-webpack": "^0.1.0",
-    "tar": "^6.0.5",
-    "ts-loader": "^7.0.5",
-    "typescript": "^3.9.3",
-    "webpack": "^4.43.0",
-    "webpack-cli": "^3.3.11",
-    "yargs": "^16.2.0"
-  },
-  "browser": {
-    "fs": false
-  },
-  "dependencies": {
-    "electron-log": "^4.3.1"
-  }
-}
+{
+  "name": "joplin-plugin-backup",
+  "version": "1.0.5",
+  "scripts": {
+    "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
+    "prepare": "npm run dist && husky install",
+    "update": "npm install -g generator-joplin && yo joplin --update",
+    "release": "npm test && node ./node_modules/joplinplugindevtools/dist/createRelease.js",
+    "preRelease": "npm test && node ./node_modules/joplinplugindevtools/dist/createRelease.js --prerelease",
+    "gitRelease": "node ./node_modules/joplinplugindevtools/dist/createRelease.js --upload",
+    "gitPreRelease": "node ./node_modules/joplinplugindevtools/dist/createRelease.js --upload --prerelease",
+    "test": "jest"
+  },
+  "license": "MIT",
+  "keywords": [
+    "joplin-plugin"
+  ],
+  "devDependencies": {
+    "@types/jest": "^26.0.23",
+    "@types/node": "^14.0.14",
+    "axios": "^0.21.1",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^6.1.0",
+    "dotenv": "^10.0.0",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "husky": "^6.0.0",
+    "jest": "^27.0.4",
+    "jest-when": "^3.3.1",
+    "joplinplugindevtools": "^1.0.14",
+    "lint-staged": "^11.0.0",
+    "mime": "^2.5.2",
+    "on-build-webpack": "^0.1.0",
+    "prettier": "2.3.0",
+    "tar": "^6.0.5",
+    "ts-jest": "^27.0.2",
+    "ts-loader": "^7.0.5",
+    "typescript": "^3.9.3",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11",
+    "yargs": "^16.2.0"
+  },
+  "browser": {
+    "fs": false,
+    "child_process": false
+  },
+  "dependencies": {
+    "7zip-bin": "^5.1.1",
+    "electron-log": "^4.3.1",
+    "moment": "^2.29.1",
+    "node-7z": "^2.1.2"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "moduleNameMapper": {
+      "^api$": "<rootDir>/node_modules/joplinplugindevtools/dist/apiMock.js",
+      "^api/types$": "<rootDir>/api/types"
+    }
+  }
+}

package/plugin.config.json

@@ -1,3 +1,3 @@
-{
-	"extraScripts": []
-}
+{
+  "extraScripts": []
+}

package/publish/io.github.jackgruber.backup.json

@@ -1,8 +1,8 @@
 {
 	"manifest_version": 1,
 	"id": "io.github.jackgruber.backup",
-	"app_min_version": "1.6.5",
-	"version": "0.5.3",
+	"app_min_version": "2.1.3",
+	"version": "1.0.5",
 	"name": "Simple Backup",
 	"description": "Plugin to create manual and automatic backups.",
 	"author": "JackGruber",
@@ -11,8 +11,11 @@
 	"keywords": [
 		"backup",
 		"jex",
-		"export"
+		"export",
+		"zip",
+		"7zip",
+		"encrypted"
 	],
-	"_publish_hash": "sha256:a06ac7613f921538147d44b46630bfcf84d16e0b14047e66d3ae4b7572d4d5e4",
-	"_publish_commit": "master:38846496f166020e4a8fb7be545d7d6d41f493c7"
+	"_publish_hash": "sha256:afa40d7e0ed66a962aab6cbb7a01401cced7e165c4eddec4f1bbbe13ea96187e",
+	"_publish_commit": "master:2c035a3d426785deeaacc1948a2469d0824e0c25"
 }

package/CHANGELOG.md

@@ -1,54 +0,0 @@
-# Changelog
-
-## v0.5.3 (2021-04-03)
-
-- Add: Backup settings.json
-- Optimize: #7 Better error message when a backup is created twice in a row in the same minute
-
-## v0.5.2 (2021-02-13)
-
-- Only internal changes
-
-## v0.5.1 (2021-02-07)
-
-- Fix: Incomplete backup.log with only one backup set
-
-## v0.5.0 (2021-02-07)
-
-- Add: Option for Backuplogfile
-- Add: Option to create a backup only if something has changed #3
-
-## v0.4.1 (2021-01-23)
-
-- Optimize: Store profile data in `profile` folder
-
-## v0.4.0 (2021-01-21)
-
-- Add `templates` to backup
-- Optimize: Delete old backups at the end of the backup job
-
-## v0.3.1 (2021-01-21)
-
-- Fix #1: Unsupported characters in filename
-
-## v0.3.0 (2021-01-17)
-
-- Fix: Backup not only the last 50 notebooks
-- Add: Backup userchrome.css and userstyle.css
-- Add: Option to create single file JEX for all notebooks
-
-## v0.2.2 (2021-01-17)
-
-- Fix: Check if keymap-desktop.json exists
-
-## v0.2.1 (2021-01-16)
-
-- remove seconds from folder
-
-## v0.2.0 (2021-01-14)
-
-- Add: Automatic backups every X hours
-
-## v0.1.0 (2021-01-14)
-
-- First version