Restructure with new packaging changes - fix func plugin with changes

Author: tbarlow12

README.md

@@ -96,6 +96,35 @@ Please create issues in this repo for any problems or questions you find. Before
 
 We're still in the process of getting everying running 100%, but please refer to the [Serverless contributing guidlines](https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md) for information on how to contribute and code of conduct.
 
+#### Local dev
+
+1. Clone this repository to your local machine
+2. Navigate to the cloned folder
+3. Run `npm install`
+4. Run `npm run-script build`
+5. Navigate to a folder where you created a new Serverless project, run `npm install`, and then run `npm link {path to serverless-azure-functions folder}`. Running `npm install` after the link command may override the link.
+6. The npm modules should now contain your local version of this plugin.  
+
+#### Signing commits
+
+All commits in your Pull Request will need to be signed. When looking at the commits in the pull request, you will see a green 'verified' icon next to your commit. Commit signature verification is discussed [here](https://help.github.com/en/articles/about-commit-signature-verification)
+
+Follow the directions [here](https://help.github.com/en/articles/signing-commits) to configure commit signing.
+
+If any of your commits are not signed, your pull request will not be able to be merged into the base branch. You can fix this by squashing any unsigned commits into signed commits using an interactive rebase, and force pushing your new commit history. More detail [here](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
+
+When using Windows you may also encounter an error when trying to sign a commit, stating that a security key could not be found. Ensure that you have set the path the gpg in the git config: `git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"`
+
+#### Signing commits
+
+All commits in your Pull Request will need to be signed. When looking at the commits in the pull request, you will see a green 'verified' icon next to your commit. Commit signature verification is discussed [here](https://help.github.com/en/articles/about-commit-signature-verification)
+
+Follow the directions [here](https://help.github.com/en/articles/signing-commits) to configure commit signing.
+
+If any of your commits are not signed, your pull request will not be able to be merged into the base branch. You can fix this by squashing any unsigned commits into signed commits using an interactive rebase, and force pushing your new commit history. More detail [here](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
+
+When using Windows you may also encounter an error when trying to sign a commit, stating that a security key could not be found. Ensure that you have set the path the gpg in the git config: `git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"`
+
 ## License
 
 [MIT](LICENSE)

package-lock.json

@@ -14,7 +14,7 @@
     "test": "jest",
     "test:ci": "npm run test -- --ci",
     "test:coverage": "npm run test -- --coverage",
-    "prebuild": "rm lib/ -rf",
+    "prebuild": "shx rm -rf lib/ && npm run test",
     "build": "tsc"
   },
   "repository": {
@@ -48,11 +48,13 @@
     "@babel/runtime": "^7.4.5",
     "@types/jest": "^24.0.13",
     "@types/lodash": "^4.14.130",
+    "@types/mock-fs": "^3.6.30",
     "@types/open": "^6.1.0",
     "@types/request": "^2.48.1",
     "@types/serverless": "^1.18.2",
     "@typescript-eslint/eslint-plugin": "^1.9.0",
     "@typescript-eslint/parser": "^1.9.0",
+    "axios-mock-adapter": "^1.16.0",
     "babel-jest": "^24.8.0",
     "babel-preset-react-app": "^9.0.0",
     "coveralls": "^3.0.3",
@@ -61,6 +63,7 @@
     "jest-cli": "^24.8.0",
     "mock-fs": "^4.10.0",
     "serverless": "^1.44.1",
+    "shx": "^0.3.2",
     "typescript": "^3.4.5"
   },
   "optionalDependencies": {
@@ -70,4 +73,4 @@
   "engines": {
     "node": ">= 6.5.0"
   }
-}
+}

package.json

@@ -0,0 +1,25 @@
+export interface FunctionEvent {
+  http?: boolean;
+  "x-azure-settings"?: {
+    authLevel?: string;
+    direction?: string;
+    name?: string;
+  };
+}
+
+export interface ServicePrincipalEnvVariables {
+  azureSubId: string;
+  azureServicePrincipalClientId: string;
+  azureServicePrincipalPassword: string;
+  azureServicePrincipalTenantId: string;
+}
+
+export interface FunctionMetadata {
+  handler: string;
+  events: FunctionEvent[];
+}
+
+export interface AzureServiceProvider {
+  resourceGroup: string;
+  deploymentName: string;
+}

src/models/azureProvider.ts

@@ -0,0 +1,8 @@
+export interface ServerlessAzureConfig {
+  provider: {
+    name: string;
+    location: string;
+  };
+  plugins: string[];
+  functions: any;
+}

src/models/serverless.ts

@@ -1,18 +1,19 @@
 import fs from "fs";
 import mockFs from "mock-fs";
-import path from "path";
+import rimraf from "rimraf";
 import { MockFactory } from "../../test/mockFactory";
 import { invokeHook } from "../../test/utils";
 import { AzureFuncPlugin } from "./azureFunc";
-import rimraf from "rimraf";
 
 describe("Azure Func Plugin", () => {
-  
+
   it("displays a help message", async () => {
     const sls = MockFactory.createTestServerless();
     const options = MockFactory.createTestServerlessOptions();
+
     const plugin = new AzureFuncPlugin(sls, options);
     await invokeHook(plugin, "func:func");
+
     expect(sls.cli.log).toBeCalledWith("Use the func plugin to add or remove functions within Function App");
   })
 
@@ -24,73 +25,82 @@ describe("Azure Func Plugin", () => {
           "index.js": "contents",
           "function.json": "contents",
         },
-        "serverless.yml": MockFactory.createTestServerlessYml(true),
-      }, {createCwd: true, createTmp: true})
+        "serverless.yml": MockFactory.createTestServerlessYml(true) as any,
+      });
     });
-  
+
     afterAll(() => {
       mockFs.restore();
     });
 
+    afterEach(() => {
+      jest.clearAllMocks();
+    })
+
     it("returns with missing name", async () => {
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
+
       const plugin = new AzureFuncPlugin(sls, options);
       await invokeHook(plugin, "func:add:add");
+
       expect(sls.cli.log).toBeCalledWith("Need to provide a name of function to add")
     });
-  
+
     it("returns with pre-existing function", async () => {
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
-      options["name"] = "myExistingFunction";
+      options["name"] = "hello";
+
       const plugin = new AzureFuncPlugin(sls, options);
       await invokeHook(plugin, "func:add:add");
-      expect(sls.cli.log).toBeCalledWith("Function myExistingFunction already exists");
+
+      expect(sls.cli.log).toBeCalledWith("Function hello already exists");
     });
-  
-    it("creates function directory and updates serverless.yml", async () => {
+
+    it("creates function handler and updates serverless.yml", async () => {
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
       const functionName = "myFunction";
       options["name"] = functionName;
+      const expectedFunctionsYml = MockFactory.createTestSlsFunctionConfig();
+      expectedFunctionsYml[functionName] = MockFactory.createTestFunctionMetadata(functionName);
+
       const plugin = new AzureFuncPlugin(sls, options);
-      const mkdirSpy = jest.spyOn(fs, "mkdirSync");
+
       await invokeHook(plugin, "func:add:add");
-      expect(mkdirSpy).toBeCalledWith(functionName);
-      const calls = (sls.utils.writeFileSync as any).mock.calls;
-      expect(calls[0][0]).toBe(path.join(functionName, "index.js"));
-      expect(calls[1][0]).toBe(path.join(functionName, "function.json"));
-      const expectedFunctionsYml = MockFactory.createTestFunctionsMetadata();
-      expectedFunctionsYml[functionName] = MockFactory.createTestFunctionMetadata();
-      expect(calls[2][0]).toBe("serverless.yml");
-      expect(calls[2][1]).toBe(MockFactory.createTestServerlessYml(true, expectedFunctionsYml));
+
+      const writeFileCalls = (sls.utils.writeFileSync as any).mock.calls;
+      expect(writeFileCalls[0][0]).toBe(`./${functionName}.js`);
+
+      expect(writeFileCalls[1][0]).toBe("serverless.yml");
+      expect(writeFileCalls[1][1]).toBe(MockFactory.createTestServerlessYml(true, expectedFunctionsYml));
     });
   });
 
-  describe("Remove command", () => {  
-    
+  describe("Remove command", () => {
+
     beforeAll(() => {
       mockFs({
+        "index.js": "contents",
         "function1": {
-          "index.js": "contents",
           "function.json": "contents",
         },
-      }, {createCwd: true, createTmp: true});    
+      });
     });
-  
+
     afterAll(() => {
       mockFs.restore();
     });
-  
+
     it("returns with missing name", async () => {
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
       const plugin = new AzureFuncPlugin(sls, options);
       await invokeHook(plugin, "func:remove:remove");
       expect(sls.cli.log).toBeCalledWith("Need to provide a name of function to remove")
     });
-  
+
     it("returns with non-existing function", async () => {
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
@@ -99,17 +109,25 @@ describe("Azure Func Plugin", () => {
       await invokeHook(plugin, "func:remove:remove");
       expect(sls.cli.log).toBeCalledWith("Function myNonExistingFunction does not exist");
     });
-  
+
     it("deletes directory and updates serverless.yml", async () => {
+      mockFs({
+        "hello.js": "contents",
+        hello: {
+          "function.json": "contents",
+        }
+      })
       const sls = MockFactory.createTestServerless();
       const options = MockFactory.createTestServerlessOptions();
       const plugin = new AzureFuncPlugin(sls, options);
-      const functionName = "function1";
+      const functionName = "hello";
       options["name"] = functionName;
+      const unlinkSpy = jest.spyOn(fs, "unlinkSync");
       const rimrafSpy = jest.spyOn(rimraf, "sync");
       await invokeHook(plugin, "func:remove:remove");
+      expect(unlinkSpy).toBeCalledWith(`${functionName}.js`)
       expect(rimrafSpy).toBeCalledWith(functionName);
-      const expectedFunctionsYml = MockFactory.createTestFunctionsMetadata();
+      const expectedFunctionsYml = MockFactory.createTestSlsFunctionConfig();
       delete expectedFunctionsYml[functionName];
       expect(sls.utils.writeFileSync).toBeCalledWith("serverless.yml", MockFactory.createTestServerlessYml(true, expectedFunctionsYml))
     });

src/plugins/func/azureFunc.test.ts

@@ -1,12 +1,10 @@
-import fs from "fs";
-import path from "path";
-import rimraf from "rimraf";
 import Serverless from "serverless";
-import { FuncPluginUtils } from "./funcUtils";
+import { FuncService } from "../../services/funcService";
 
 export class AzureFuncPlugin {
   public hooks: { [eventName: string]: Promise<any> };
   public commands: any;
+  private service: FuncService;
 
 
   public constructor(private serverless: Serverless, private options: Serverless.Options) {
@@ -50,64 +48,19 @@ export class AzureFuncPlugin {
         }
       }
     }
+
+    this.service = new FuncService(serverless, options);
   }
 
   private async func() {
     this.serverless.cli.log("Use the func plugin to add or remove functions within Function App");
   }
 
   private async add() {
-    if (!("name" in this.options)) {
-      this.serverless.cli.log("Need to provide a name of function to add");
-      return;
-    }
-    const funcToAdd = this.options["name"]
-    const exists = fs.existsSync(funcToAdd);
-    if (exists) {
-      this.serverless.cli.log(`Function ${funcToAdd} already exists`);
-      return;
-    }
-    this.createFunctionDir(funcToAdd);
-    this.addToServerlessYml(funcToAdd);
-  }
-
-  private createFunctionDir(name: string) {
-    this.serverless.cli.log("Creating function dir");
-    try {
-      fs.mkdirSync(name);
-    } catch (e) {
-      this.serverless.cli.log(`Error making directory ${e}`);
-    }
-    this.serverless.utils.writeFileSync(path.join(name, "index.js"), FuncPluginUtils.getFunctionHandler(name));
-    this.serverless.utils.writeFileSync(path.join(name, "function.json"), FuncPluginUtils.getFunctionJsonString(name, this.options));
-  }
-
-  private addToServerlessYml(name: string) {
-    this.serverless.cli.log("Adding to serverless.yml");
-    const functionYml = FuncPluginUtils.getFunctionsYml(this.serverless);
-    functionYml[name] = FuncPluginUtils.getFunctionSlsObject(name, this.options);
-    FuncPluginUtils.updateFunctionsYml(this.serverless, functionYml);
+    this.service.add();
   }
 
   private async remove() {
-    if (!("name" in this.options)) {
-      this.serverless.cli.log("Need to provide a name of function to remove");
-      return;
-    }
-    const funcToRemove = this.options["name"];
-    const exists = fs.existsSync(funcToRemove);
-    if (!exists) {
-      this.serverless.cli.log(`Function ${funcToRemove} does not exist`);
-      return;
-    }
-    this.serverless.cli.log(`Removing ${funcToRemove}`);
-    rimraf.sync(funcToRemove);
-    await this.removeFromServerlessYml(funcToRemove);
-  }
-
-  private async removeFromServerlessYml(name: string) {
-    const functionYml = FuncPluginUtils.getFunctionsYml(this.serverless);
-    delete functionYml[name];
-    FuncPluginUtils.updateFunctionsYml(this.serverless, functionYml)
+    this.service.remove();
   }
 }