Merge pull request #8 from fac/allow-specifying-developer-file

Allow specifying functions.yaml file when calling the deploy command

Author: HistoireDeBabar

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serverless-tools (0.0.3)
+    serverless-tools (0.1.0)
       aws-sdk-lambda
       aws-sdk-s3
       thor
@@ -11,46 +11,46 @@ GEM
   specs:
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.547.0)
-    aws-sdk-core (3.125.3)
+    aws-partitions (1.557.0)
+    aws-sdk-core (3.126.2)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.53.0)
-      aws-sdk-core (~> 3, >= 3.125.0)
+    aws-sdk-kms (1.54.0)
+      aws-sdk-core (~> 3, >= 3.126.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.77.0)
-      aws-sdk-core (~> 3, >= 3.125.0)
+    aws-sdk-lambda (1.78.0)
+      aws-sdk-core (~> 3, >= 3.126.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.111.1)
-      aws-sdk-core (~> 3, >= 3.125.0)
+    aws-sdk-s3 (1.112.0)
+      aws-sdk-core (~> 3, >= 3.126.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
     aws-sigv4 (1.4.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    jmespath (1.5.0)
+    jmespath (1.6.0)
     minitest (5.15.0)
     mocha (1.13.0)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     power_assert (2.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rubocop (1.24.1)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     test-unit (3.5.3)
       power_assert

README.md

@@ -38,9 +38,9 @@ The deployer takes 2 arguments:
 The deployer uses the current git HEAD for which sha to push and update.
 
 ```zsh
-  serverless deploy build # Zips the file - assumes bundle install has been run and deps are in a vendor folder
-  serverless deploy push # Push the zip(s) to S3
-  serverless deploy update # Update the lambda function
+  serverless-tools deploy build # Zips the file - assumes bundle install has been run and deps are in a vendor folder
+  serverless-tools deploy push # Push the zip(s) to S3
+  serverless-tools deploy update # Update the lambda function
 ```
 
 ### Comment
@@ -49,7 +49,7 @@ The comment tool is intended to be used as a Github Action. It takes a json hash
 and prints a formatted string with the Github Action expression to set an output. This output can then used to comment in a Github Issue.
 
 ```zsh
-  serverless comment -f '{"function_name": "Success"}'
+  serverless-tools comment -f '{"function_name": "Success"}'
 ```
 ### Github Actions
 

lib/serverless-tools/cli.rb

@@ -12,8 +12,9 @@ def comment
     end
 
     desc "deploy", "publishes and deploys the specified lambda functions"
+    method_option :filename, :type => :string, :aliases => "-f"
     def deploy(action, function=nil)
-      Deployer.deploy(action: action, function: function)
+      Deployer.deploy(action: action, function: function, filename: options[:filename])
     end
   end
 end

lib/serverless-tools/deployer.rb

@@ -5,12 +5,12 @@
 
 module ServerlessTools
   module Deployer
-    CONFIG_FILE = ENV["GITHUB_WORKSPACE"] ? "#{ENV["GITHUB_WORKSPACE"]}/functions.yml" : "functions.yml"
-
-    def self.deploy(action:, function: nil)
+    def self.deploy(action:, function: nil, filename: nil)
       raise "Expected to receive action but action was empty" if action.nil? || action.empty?
 
-      config_loader = YamlConfigLoader.new(filename: CONFIG_FILE)
+      config_loader = YamlConfigLoader.new(
+        filename: filename.nil? ? "functions.yml" : filename
+      )
 
       lambdas_to_deploy = function ? [function] : config_loader.functions
 

lib/serverless-tools/version.rb

@@ -1,3 +1,3 @@
 module ServerlessTools
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

test/deployer_test.rb

@@ -0,0 +1,37 @@
+require "minitest/autorun"
+require "mocha/minitest"
+
+require "serverless-tools/deployer"
+
+module ServerlessTools
+  describe "Deployer" do
+    let(:deployer) { mock() }
+    let(:config) { mock() }
+
+    let(:function) { "example_function_one_v1" }
+    let(:filename) { "functions.yml" }
+
+
+    describe "#deployer" do
+      before do
+        Deployer::YamlConfigLoader.stubs(:new).with(filename: filename).returns(config)
+        Deployer::Deployer.stubs(:new).returns(deployer)
+
+        config.expects(:lambda_config).with(function_name: function)
+        deployer.expects(:build)
+      end
+
+      it "sends the action to the created deployer" do
+        Deployer.deploy(action: "build", function: function)
+      end
+
+      describe "when specifying a different config file" do
+        let(:filename) { "dev.functions.yml" }
+
+        it "loads the correct file" do
+          Deployer.deploy(action: "build", function: function, filename: filename)
+        end
+      end
+    end
+  end
+end