test_cli.rb

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require "helper"

require "net/http"
require "uri"

require "functions_framework/cli"

describe FunctionsFramework::CLI do
  let(:http_source) { File.join __dir__, "function_definitions", "simple_http.rb" }
  let(:event_source) { File.join __dir__, "function_definitions", "simple_event.rb" }
  let(:http_return_source) { File.join __dir__, "function_definitions", "return_http.rb" }
  let(:startup_source) { File.join __dir__, "function_definitions", "startup_block.rb" }
  let(:retry_count) { 10 }
  let(:retry_interval) { 0.5 }
  let(:port) { "8066" }
  let(:pidfile) { "server.pid" }
  let(:timeout) { 10 }

  def run_with_retry cli
    server = cli.start_server
    begin
      last_error = nil
      retry_count.times do
        return yield
      rescue ::SystemCallError => e
        last_error = e
        sleep retry_interval
      end
      raise last_error
    ensure
      server.stop.wait_until_stopped timeout: timeout
    end
  end

  def run_in_timeout cli
    ::Timeout.timeout(timeout) { cli.run }
  end

  before do
    @saved_registry = FunctionsFramework.global_registry
    FunctionsFramework.global_registry = FunctionsFramework::Registry.new
    @saved_level = FunctionsFramework.logger.level
  end

  after do
    FunctionsFramework.global_registry = @saved_registry
    FunctionsFramework.logger.level = @saved_level
    ENV["FUNCTION_TARGET"] = nil
    ENV["FUNCTION_SOURCE"] = nil
    ENV["FUNCTION_SIGNATURE_TYPE"] = nil
  end

  it "prints the version when given the --version flag" do
    args = [
      "--version"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    assert_output "#{FunctionsFramework::VERSION}\n" do
      run_in_timeout cli
    end
    assert_nil cli.error_message
    assert_equal 0, cli.exit_code
    refute cli.error?
  end

  it "prints online help when given the --help flag" do
    args = [
      "--help"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    assert_output(/^Usage:/) do
      run_in_timeout cli
    end
    assert_nil cli.error_message
    assert_equal 0, cli.exit_code
    refute cli.error?
  end

  it "runs an http server" do
    args = [
      "--source", http_source,
      "--target", "simple_http",
      "--port", port,
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    response = run_with_retry cli do
      Net::HTTP.get_response URI("http://127.0.0.1:#{port}/")
    end
    assert_equal "200", response.code
    assert_equal "I received a request: GET http://127.0.0.1:#{port}/", response.body
  end

  it "runs an http server with a pidfile" do
    args = [
      "--source", http_source,
      "--target", "simple_http",
      "--port", port,
      "--pidfile", pidfile,
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    _response = run_with_retry cli do
      Net::HTTP.get_response URI("http://127.0.0.1:#{port}/")
    end
    assert_equal pidfile, cli.pidfile
  end

  it "runs an http server with a function that includes a return" do
    args = [
      "--source", http_return_source,
      "--target", "return_http",
      "--port", port,
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    response = run_with_retry cli do
      Net::HTTP.get_response URI("http://127.0.0.1:#{port}/")
    end
    assert_equal "200", response.code
    assert_equal "I received a GET request: http://127.0.0.1:#{port}/", response.body
  end

  it "succeeds the signature type check for an http server" do
    args = [
      "--source", http_source,
      "--target", "simple_http",
      "--port", port,
      "--signature-type", "http",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    run_with_retry cli do
      # Do nothing
    end
  end

  it "fails the signature type check for an http server" do
    args = [
      "--source", http_source,
      "--target", "simple_http",
      "--port", port,
      "--signature-type", "cloudevent",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    error = assert_raises RuntimeError do
      run_with_retry cli do
        # Do nothing
      end
    end
    assert_match(/Function "simple_http" does not match type cloudevent/, error.message)
  end

  it "succeeds the signature type check for an event server" do
    args = [
      "--source", event_source,
      "--target", "simple_event",
      "--port", port,
      "--signature-type", "cloudevent",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    run_with_retry cli do
      # Do nothing
    end
  end

  it "succeeds the signature type check for a legacy event server" do
    args = [
      "--source", event_source,
      "--target", "simple_event",
      "--port", port,
      "--signature-type", "event",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    run_with_retry cli do
      # Do nothing
    end
  end

  it "fails the signature type check for an event server" do
    args = [
      "--source", event_source,
      "--target", "simple_event",
      "--port", port,
      "--signature-type", "http",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    error = assert_raises RuntimeError do
      run_with_retry cli do
        # Do nothing
      end
    end
    assert_match(/Function "simple_event" does not match type http/, error.message)
  end

  it "passes verification" do
    args = [
      "--verify",
      "--source", http_source,
      "--target", "simple_http",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    assert_output "OK\n" do
      run_in_timeout cli
    end
    assert_nil cli.error_message
    assert_equal 0, cli.exit_code
    refute cli.error?
  end

  it "fails verification if the target specifies a nonexistent function" do
    args = [
      "--verify",
      "--source", http_source,
      "--target", "wrong_function_name",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    run_in_timeout cli
    assert_equal 'Undefined function: "wrong_function_name"', cli.error_message
    assert_equal 1, cli.exit_code
    assert cli.error?
  end

  it "fails on an unrecognized flag" do
    args = [
      "--blahblahblah"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    run_in_timeout cli
    assert_match(/^invalid option: --blahblahblah/, cli.error_message)
    assert_equal 2, cli.exit_code
    assert cli.error?
  end

  it "runs a startup block" do
    args = [
      "--source", startup_source,
      "--target", "simple_http",
      "--port", port
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    response = nil
    _out, err = capture_subprocess_io do
      response = run_with_retry cli do
        Net::HTTP.get_response URI("http://127.0.0.1:#{port}/")
      end
    end
    assert_match(/in startup block/, err)
    assert_equal "200", response.code
    assert_equal "OK", response.body
  end

  it "does not run startup block in verify mode" do
    args = [
      "--verify",
      "--source", startup_source,
      "--target", "simple_http",
      "-q"
    ]
    cli = FunctionsFramework::CLI.new.parse_args args
    assert_output "OK\n" do
      run_in_timeout cli
    end
  end
end