RubyGems - google-serverless-exec - Versions diffs - 0.1.0 → 0.2.0 - Mend

google-serverless-exec 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +15 -2
data/data/exec_standard_entrypoint.rb.erb +116 -0
data/lib/google/serverless/exec/railtie.rb +40 -0
data/lib/google/serverless/exec/tasks.rb +158 -137
data/lib/google/serverless/exec/version.rb +1 -1
data/lib/google/serverless/exec.rb +74 -56
data/lib/google-serverless-exec.rb +18 -0
metadata +18 -42

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9649c833b15ac827ec528c9834a0c44e1fd4f0f39c98f849fac9da49b469aee6
-  data.tar.gz: 7d848bb54ede49bc2758d028a777a68c6c3e73704b7a0325474ffa26a6e87861
+  metadata.gz: 754f4dd5168b02b49ef0f4104989ecfdf256959f51aa1923bd7911c9eb3fa498
+  data.tar.gz: 1e79015a91772bc612166825c3b41723678a5451dc795373b29a19d3b03206fd
 SHA512:
-  metadata.gz: 621be644a9cc61b56697d6c8b28237e40c91cbda3105e73b3422714357698ee58afcbf7001ac669ae6d26785c462627acc8c6c59119d90ed52f814256d823102
-  data.tar.gz: '0568e46e630b6774612c7cc548e8d827eaeb975034ffefc53492c24eecb5baad3f7165d91c673fd8ef6d0644a70180e9ae268cf412517fa1aca91fe2fbe6c802'
+  metadata.gz: aad33d97d17a7074d4145a49de59a4bc932908452bcb8e65813295bab0307e6a1307e2dab170c9e247277a6f9039cf8ed73fe66890dcc5bf2cae545e65b98ef6
+  data.tar.gz: 6c5c69a97c45c5ddb28d497d23dc8089fea57e2e5f20036905ee2eaf236423e328a62405468b75d817f76b8df7dc0301668ca034e55286b4110f68d4e0577410

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,18 @@
 # Changelog
-### v0.1.0 / 2021-08-04
+## 0.2.0 (2021-09-13)
-* Initial release
+### Features
+* Install the rake task automatically in Rails apps
+* Provide a way to set the project and region for cloud run
+### Bug Fixes
+* Fix deployment strategy by including the entrypoint implementation
+* Fix gem description and links
+* Update task parameter names and documentation
+## v0.1.0 / 2021-08-04
+* Initial release

data/data/exec_standard_entrypoint.rb.erb ADDED Viewed

@@ -0,0 +1,116 @@
+# Copyright 2019 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
+#
+#     http://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 "webrick"
+require "monitor"
+require "json"
+SECRET = <%= secret %>
+COMMAND = Array(<%= command %>)
+port = Integer ENV["PORT"]
+server = ::WEBrick::HTTPServer.new Port: port
+Status = ::Struct.new :out_lines, :err_lines, :exit_status, :pid, :start_time
+$status = Status.new [], [], nil, nil, nil
+$status.extend ::MonitorMixin
+def do_start
+  $status.synchronize do
+    return unless $status.pid.nil?
+  end
+  $stdout.puts "Executing: #{COMMAND.inspect}"
+  $stdout.flush
+  rout, wout = ::IO.pipe
+  rerr, werr = ::IO.pipe
+  ::Thread.new do
+    rout.each_line do |line|
+      $status.synchronize { $status.out_lines << line }
+      $stdout.puts line
+      $stdout.flush
+    end
+  end
+  ::Thread.new do
+    rerr.each_line do |line|
+      $status.synchronize { $status.err_lines << line }
+      $stderr.puts line
+      $stderr.flush
+    end
+  end
+  start_time = Time.now.to_i
+  pid = ::Process.spawn *COMMAND, err: werr, out: wout
+  werr.close
+  wout.close
+  $status.synchronize do
+    $status.pid = pid
+    $status.start_time = start_time
+  end
+  ::Thread.new do
+    _pid, status = ::Process.wait2 pid
+    $status.synchronize do
+      $status.exit_status = status.exitstatus
+    end
+  end
+end
+def get_status outpos: 0, errpos: 0
+  outlines, errlines, status, start_time =
+    $status.synchronize do
+      [
+        $status.out_lines[outpos..-1],
+        $status.err_lines[errpos..-1],
+        $status.exit_status,
+        $status.start_time
+      ]
+    end
+  {
+    "outpos" => outpos + outlines.size,
+    "errpos" => errpos + errlines.size,
+    "outlines" => outlines,
+    "errlines" => errlines,
+    "status" => status,
+    "time" => Time.now.to_i - start_time
+  }
+end
+server.mount_proc "/_ah/start" do |req, res|
+  do_start
+end
+server.mount_proc "/#{SECRET}" do |req, res|
+  do_start
+  status = get_status outpos: req.query["outpos"].to_i,
+                      errpos: req.query["errpos"].to_i
+  res.body = JSON.dump status
+end
+server.mount_proc "/#{SECRET}/kill" do |req, res|
+  unless req.request_method == "POST"
+    res.status = 404
+    return
+  end
+  $status.synchronize do
+    if $status.pid.nil?
+      res.status = 404
+      return
+    end
+    ::Process.kill "SIGTERM", $status.pid
+  end
+end
+begin
+  server.start
+ensure
+  server.shutdown
+end

data/lib/google/serverless/exec/railtie.rb ADDED Viewed

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+# Copyright 2021 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
+#
+#     http://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.
+module Google
+  module Serverless
+    class Exec
+      ##
+      # A Railtie that automatically adds the serverless:exec rake task.
+      #
+      # This Railtie is loaded automatically if this gem is included in a
+      # Rails app. You may opt out by including the following line in your
+      # Rails configuration:
+      #
+      #     config.google_serverless.define_exec_task = false
+      #
+      class Railtie < ::Rails::Railtie
+        config.google_serverless = ::ActiveSupport::OrderedOptions.new
+        config.google_serverless.define_exec_task = true
+        rake_tasks do |app|
+          require "google/serverless/exec/tasks" if app.config.google_serverless.define_exec_task
+        end
+      end
+    end
+  end
+end

data/lib/google/serverless/exec/tasks.rb CHANGED Viewed

@@ -24,25 +24,28 @@ module Google
   module Serverless
     class Exec
       ##
-      # # Serverless Rake Tasks.
+      # # Rake Task for serverless exec
       #
-      # To make these tasks available, add the line `require "google/serverless/exec/tasks"`
-      # to your Rakefile. If your app uses Ruby on Rails, then the serverless gem
-      # provides a railtie that adds its tasks automatically, so you don't have
-      # to do anything beyond adding the gem to your Gemfile.
+      # This module implements the `serverless:exec` rake task. To make it
+      # available, add the line
       #
-      # The following tasks are defined:
+      #     require "google/serverless/exec/tasks"
       #
-      # ## Rake serverless:exec
+      # to your Rakefile. If your app uses Ruby on Rails, then the gem provides
+      # a railtie that adds this task automatically, so you don't have to do
+      # anything beyond adding the gem to your Gemfile.
       #
-      # Executes a given command in the context of a serverless application.
-      # See {Google::Serverless::Exec} for more information on this capability.
+      # ## Usage
+      #
+      # The `serverless:exec` a given command in the context of a serverless
+      # application. See {Google::Serverless::Exec} for more information on
+      # this capability.
       #
       # The command to be run may either be provided as a rake argument, or as
       # command line arguments, delimited by two dashes `--`. (The dashes are
       # needed to separate your command from rake arguments and flags.)
-      # For example, to run a production database migration, you can run either of
-      # the following equivalent commands:
+      # For example, to run a production database migration, you can run either
+      # of the following equivalent commands:
       #
       #     bundle exec rake "serverless:exec[bundle exec bin/rails db:migrate]"
       #     bundle exec rake serverless:exec -- bundle exec bin/rails db:migrate
@@ -51,95 +54,114 @@ module Google
       #
       #     bundle exec rake serverless:exec --
       #
-      # ### Parameters
+      # ## Parameters
       #
       # You may customize the behavior of the serverless execution through a few
-      # enviroment variable parameters. These are set via the normal mechanism at
-      # the end of a rake command line. For example, to set GAE_CONFIG:
+      # enviroment variable parameters. These are set via the normal mechanism
+      # at the end of a rake command line. For example, to set EXEC_APP_CONFIG:
       #
-      #     bundle exec rake serverless:exec GAE_CONFIG=myservice.yaml -- bundle exec bin/rails db:migrate
+      #     bundle exec rake serverless:exec EXEC_APP_CONFIG=myservice.yaml -- bundle exec bin/rails db:migrate
       #
       # Be sure to set these parameters before the double dash. Any arguments
       # following the double dash are interpreted as part of the command itself.
       #
       # The following environment variable parameters are supported:
       #
-      # #### GAE_TIMEOUT
+      # ### EXEC_PROJECT
+      #
+      # The ID of your Google Cloud project. If not specified, uses the current
+      # project from gcloud.
+      #
+      # ### EXEC_PRODUCT
+      #
+      # The product used to deploy the app. Valid values are `app_engine` or
+      # `cloud_run`. If omitted, the task will try to guess based on whether
+      # an App Engine config file (e.g. `app.yaml`) is present.
+      #
+      # ### EXEC_REGION
+      #
+      # The Google Cloud region to which the app is deployed. Required for
+      # Cloud Run apps.
+      #
+      # ### EXEC_STRATEGY
+      #
+      # The execution strategy to use. Valid values are `deployment` (which is
+      # the default for App Engine Standard apps) and `cloud_build` (which is
+      # the default for App Engine Flexible and Cloud Run apps).
+      #
+      # Normally you should leave the strategy set to the default. The main
+      # reason to change it is if your app runs on the Flexible Environment and
+      # talks to a database over a VPC (using a private IP address). The
+      # `cloud_build` strategy used by default for Flexible apps cannot connect
+      # to a VPC, so you should use `deployment` in this case. (But note that,
+      # otherwise, the `deployment` strategy is significantly slower for apps
+      # on the App Engine Flexible Environment.)
+      #
+      # ### EXEC_TIMEOUT
       #
       # Amount of time to wait before serverless:exec terminates the command.
-      # Expressed as a string formatted like: "2h15m10s". Default is "10m".
+      # Expressed as a string formatted like: `2h15m10s`. Default is `10m`.
       #
-      # #### GAE_PROJECT
+      # ### EXEC_SERVICE_NAME
       #
-      # The ID of your Google Cloud project. If not specified, uses the current
-      # project from gcloud.
+      # Name of the service to be used. If your app uses Cloud Run, this is
+      # required. If your app uses App Engine, normally the service name is
+      # obtained from the config file, but you can override it using this
+      # parameter.
       #
-      # #### GAE_CONFIG
+      # ### EXEC_APP_CONFIG
       #
       # Path to the App Engine config file, used when your app has multiple
       # services, or the config file is otherwise not called `./app.yaml`. The
       # config file is used to determine the name of the App Engine service.
+      # Unused for Cloud Run apps.
       #
-      # #### GAE_SERVICE
-      #
-      # Name of the service to be used. Overrides any service name specified in
-      # your config file.
+      # ### EXEC_APP_VERSION
       #
-      # #### GAE_EXEC_STRATEGY
+      # The version of the App Engine service, used to identify which
+      # application image to use to run your command. If not specified, uses
+      # the most recently created version, regardless of whether that version
+      # is actually serving traffic. Applies only to the `cloud_build` strategy
+      # for App Engine apps; ignored for the `deployment` strategy or if your
+      # app uses Cloud Run.
       #
-      # The execution strategy to use. Valid values are "deployment" (which is the
-      # default for App Engine Standard apps) and "cloud_build" (which is the
-      # default for App Engine Flexible and Cloud Run apps).
+      # ### EXEC_BUILD_LOGS_DIR
       #
-      # Normally you should leave the strategy set to the default. The main reason
-      # to change it is if your app runs on the Flexible Environment and talks to
-      # a database over a VPC (using a private IP address). The "cloud_build"
-      # strategy used by default for Flexible apps cannot connect to a VPC, so you
-      # should use "deployment" in this case. (But note that, otherwise, the
-      # "deployment" strategy is significantly slower for apps on the Flexible
-      # environment.)
+      # GCS bucket name of the cloud build log when GAE_STRATEGY is
+      # `cloud_build`. (ex. `gs://BUCKET-NAME/FOLDER-NAME`)
       #
-      # #### GAE_VERSION
-      #
-      # The version of the service, used to identify which application image to
-      # use to run your command. If not specified, uses the most recently created
-      # version, regardless of whether that version is actually serving traffic.
-      # Applies only to the "cloud_build" strategy. (The "deployment" strategy
-      # deploys its own temporary version of your app.)
-      #
-      # #### GAE_EXEC_WRAPPER_IMAGE
+      # ### EXEC_WRAPPER_IMAGE
       #
       # The fully-qualified name of the wrapper image to use. (This is a Docker
-      # image that emulates the App Engine environment in Google Cloud Build for
-      # the "cloud_build" strategy, and applies only to that strategy.) Normally,
-      # you should not override this unless you are testing a new wrapper.
-      #
-      # #### CLOUD_BUILD_GCS_LOG_DIR
+      # image that emulates the App Engine environment in Google Cloud Build
+      # for the `cloud_build` strategy, and applies only to that strategy.)
+      # Normally, you should not override this unless you are testing a new
+      # wrapper.
       #
-      # GCS bucket name of the cloud build log when GAE_STRATEGY is "cloud_build".
-      # (ex. "gs://BUCKET-NAME/FOLDER-NAME")
       module Tasks
         ## @private
-        PROJECT_ENV = "GAE_PROJECT"
+        PROJECT_ENV = "EXEC_PROJECT"
         ## @private
-        STRATEGY_ENV = "GAE_EXEC_STRATEGY"
+        STRATEGY_ENV = "EXEC_STRATEGY"
         ## @private
-        CONFIG_ENV = "GAE_CONFIG"
+        CONFIG_ENV = "EXEC_APP_CONFIG"
         ## @private
-        SERVICE_ENV = "GAE_SERVICE"
+        SERVICE_ENV = "EXEC_SERVICE_NAME"
         ## @private
-        VERSION_ENV = "GAE_VERSION"
+        VERSION_ENV = "EXEC_APP_VERSION"
         ## @private
-        TIMEOUT_ENV = "GAE_TIMEOUT"
+        TIMEOUT_ENV = "EXEC_TIMEOUT"
         ## @private
-        WRAPPER_IMAGE_ENV = "GAE_EXEC_WRAPPER_IMAGE"
+        WRAPPER_IMAGE_ENV = "EXEC_WRAPPER_IMAGE"
         ## @private
-        GCS_LOG_DIR = "CLOUD_BUILD_GCS_LOG_DIR"
+        LOGS_DIR_ENV = "EXEC_BUILD_LOGS_DIR"
         ## @private
-        PRODUCT_ENV = "PRODUCT"
+        PRODUCT_ENV = "EXEC_PRODUCT"
+        ## @private
+        REGION_ENV = "EXEC_REGION"
         @defined = false
         class << self
           ##
           # @private
@@ -151,18 +173,18 @@ module Google
               return
             end
             @defined = true
             setup_exec_task
           end
           private
           def setup_exec_task
             ::Rake.application.last_description =
               "Execute the given command in a Google serverless application."
             ::Rake::Task.define_task "serverless:exec", [:cmd] do |_t, args|
-              verify_gcloud_and_report_errors
               command = extract_command args[:cmd], ::ARGV
+              verify_gcloud_and_report_errors
               selected_product = extract_product ::ENV[PRODUCT_ENV]
               app_exec = Exec.new command,
                                   project:       ::ENV[PROJECT_ENV],
@@ -172,13 +194,14 @@ module Google
                                   timeout:       ::ENV[TIMEOUT_ENV],
                                   wrapper_image: ::ENV[WRAPPER_IMAGE_ENV],
                                   strategy:      ::ENV[STRATEGY_ENV],
-                                  gcs_log_dir:   ::ENV[GCS_LOG_DIR],
+                                  gcs_log_dir:   ::ENV[LOGS_DIR_ENV],
+                                  region:        ::ENV[REGION_ENV],
                                   product:       selected_product
               start_and_report_errors app_exec
               exit
             end
           end
           def extract_command cmd, argv
             if cmd
               ::Shellwords.split cmd
@@ -203,30 +226,27 @@ module Google
           end
           def extract_product product
-            if product
-              product = product.dup
-              product.downcase!
-              case product
-              when "app_engine"
-                APP_ENGINE
-              when "cloud_run"
-                CLOUD_RUN
-              end
-            else
-              nil
+            return unless product
+            product = product.dup
+            product.downcase!
+            case product
+            when "app_engine"
+              APP_ENGINE
+            when "cloud_run"
+              CLOUD_RUN
             end
           end
           def show_usage
             puts <<~USAGE
               rake serverless:exec
               This Rake task executes a given command in the context of a serverless
               application. For more information,
               on this capability, see the Google::Serverless::Exec documentation at
-              http://www.rubydoc.info/gems/appengine/AppEngine/Exec
+              http://www.rubydoc.info/gems/google-serverless-exec/Google/Serverless/Exec
               The command to be run may either be provided as a rake argument, or as
-              command line arguments delimited by two dashes `--`. (The dashes are
+              command line arguments delimited by two dashes "--". (The dashes are
               needed to separate your command from rake arguments and flags.)
               For example, to run a production database migration, you can run either
               of the following equivalent commands:
@@ -237,25 +257,23 @@ module Google
               You may customize the behavior of the serverless execution through a few
               enviroment variable parameters. These are set via the normal mechanism at
               the end of a rake command line but before the double dash. For example, to
-              set GAE_CONFIG:
-                  bundle exec rake serverless:exec GAE_CONFIG=myservice.yaml -- bundle exec bin/rails db:migrate
+              set EXEC_APP_CONFIG:
+                  bundle exec rake serverless:exec EXEC_APP_CONFIG=myservice.yaml -- \\
+                    bundle exec bin/rails db:migrate
               Be sure to set these parameters before the double dash. Any arguments
               following the double dash are interpreted as part of the command itself.
               The following environment variable parameters are supported:
-              GAE_TIMEOUT
-                Amount of time to wait before serverless:exec terminates the command.
-                Expressed as a string formatted like: "2h15m10s". Default is "10m".
-              GAE_PROJECT
+              EXEC_PROJECT
                 The ID of your Google Cloud project. If not specified, uses the current
                 project from gcloud.
-              GAE_CONFIG
-                Path to the App Engine config file, used when your app has multiple
-                services, or the config file is otherwise not called `./app.yaml`. The
-                config file is used to determine the name of the App Engine service.
-              GAE_SERVICE
-                Name of the service to be used. Overrides any service name specified in
-                your config file.
-              GAE_EXEC_STRATEGY
+              EXEC_PRODUCT
+                The product used to deploy the app. Valid values are "app_engine" or
+                "cloud_run". If omitted, the task will try to guess based on whether
+                an App Engine config file (e.g. app.yaml) is present.
+              EXEC_REGION
+                The Google Cloud region to which the app is deployed. Required for
+                Cloud Run apps.
+              EXEC_STRATEGY
                 The execution strategy to use. Valid values are "deployment" (which is the
                 default for App Engine Standard apps) and "cloud_build" (which is the
                 default for App Engine Flexible and Cloud Run apps).
@@ -266,34 +284,37 @@ module Google
                 should use "deployment" in this case. (But note that, otherwise, the
                 "deployment" strategy is significantly slower for apps on the Flexible
                 environment.)
-              GAE_VERSION
-                The version of the service, used to identify which application image to
-                use to run your command. If not specified, uses the most recently created
-                version, regardless of whether that version is actually serving traffic.
-                Applies only to the "cloud_build" strategy. (The "deployment" strategy
-                deploys its own temporary version of your app.)
-              GAE_EXEC_WRAPPER_IMAGE
+              EXEC_TIMEOUT
+                Amount of time to wait before serverless:exec terminates the command.
+                Expressed as a string formatted like: "2h15m10s". Default is "10m".
+              EXEC_SERVICE_NAME
+                Name of the service to be used. If your app uses Cloud Run, this is
+                required. If your app uses App Engine, normally the service name is
+                obtained from the config file, but you can override it using this
+                parameter.
+              EXEC_APP_CONFIG
+                Path to the App Engine config file, used when your app has multiple
+                services, or the config file is otherwise not called "./app.yaml". The
+                config file is used to determine the name of the App Engine service.
+                Unused for Cloud Run apps.
+              EXEC_APP_VERSION
+                The version of the App Engine service, used to identify which
+                application image to use to run your command. If not specified, uses
+                the most recently created version, regardless of whether that version
+                is actually serving traffic. Applies only to the "cloud_build" strategy
+                for App Engine apps; ignored for the "deployment" strategy or if your
+                app uses Cloud Run.
+              EXEC_BUILD_LOGS_DIR
+                GCS bucket name of the cloud build log when GAE_STRATEGY is "cloud_build".
+                (ex. "gs://BUCKET-NAME/FOLDER-NAME")
+              EXEC_WRAPPER_IMAGE
                 The fully-qualified name of the wrapper image to use. (This is a Docker
                 image that emulates the App Engine environment in Google Cloud Build for
                 the "cloud_build" strategy, and applies only to that strategy.) Normally,
                 you should not override this unless you are testing a new wrapper.
-              CLOUD_BUILD_GCS_LOG_DIR
-                GCS bucket name of the cloud build log when GAE_STRATEGY is "cloud_build".
-                (ex. "gs://BUCKET-NAME/FOLDER-NAME")
-              PRODUCT
-                The serverless product to use. Valid values are "app_engine" and "cloud_run".
-                If not specified, autodetects the serverless product to use.
-              This rake task is provided by the "serverless" gem. To make these tasks
-              available, add the following line to your Rakefile:
-                  require "google/serverless/exec/tasks"
-              If your app uses Ruby on Rails, the gem provides a railtie that adds its
-              tasks automatically, so you don't have to do anything beyond adding the
-              gem to your Gemfile.
-              For more information or to report issues, visit the Github page:
-              https://github.com/GoogleCloudPlatform/google-serverless-exec
             USAGE
           end
           def verify_gcloud_and_report_errors
             Exec::Gcloud.verify!
           rescue Exec::Gcloud::BinaryNotFound
@@ -318,42 +339,42 @@ module Google
               running `gcloud config set project <project-name>`.
             MESSAGE
           end
           def start_and_report_errors app_exec
             app_exec.start
           rescue Exec::ConfigFileNotFound => e
             report_error <<~MESSAGE
               Could not determine which service should run this command because the App
               Engine config file "#{e.config_path}" was not found.
-              Specify the config file using the GAE_CONFIG argument. e.g.
-                bundle exec rake serverless:exec GAE_CONFIG=myapp.yaml -- myscript.sh
-              Alternately, you may specify a service name directly with GAE_SERVICE. e.g.
-                bundle exec rake serverless:exec GAE_SERVICE=myservice -- myscript.sh
+              Specify the config file using the EXEC_APP_CONFIG argument. e.g.
+                bundle exec rake serverless:exec EXEC_APP_CONFIG=myapp.yaml -- myscript.sh
+              Alternately, specify a service name directly with EXEC_SERVICE_NAME. e.g.
+                bundle exec rake serverless:exec EXEC_SERVICE_NAME=myservice -- myscript.sh
             MESSAGE
           rescue Exec::BadConfigFileFormat => e
             report_error <<~MESSAGE
               Could not determine which service should run this command because the App
               Engine config file "#{e.config_path}" was malformed.
               It must be a valid YAML file.
-              Specify the config file using the GAE_CONFIG argument. e.g.
-                bundle exec rake serverless:exec GAE_CONFIG=myapp.yaml -- myscript.sh
-              Alternately, you may specify a service name directly with GAE_SERVICE. e.g.
-                bundle exec rake serverless:exec GAE_SERVICE=myservice -- myscript.sh
+              Specify the config file using the EXEC_APP_CONFIG argument. e.g.
+                bundle exec rake serverless:exec EXEC_APP_CONFIG=myapp.yaml -- myscript.sh
+              Alternately, specify a service name directly with EXEC_SERVICE_NAME. e.g.
+                bundle exec rake serverless:exec EXEC_SERVICE_NAME=myservice -- myscript.sh
             MESSAGE
           rescue Exec::NoSuchVersion => e
             if e.version
               report_error <<~MESSAGE
                 Could not find version "#{e.version}" of service "#{e.service}".
                 Please double-check the version exists. To use the most recent version by
-                default, omit the GAE_VERSION argument.
+                default, omit the EXEC_APP_VERSION argument.
               MESSAGE
             else
               report_error <<~MESSAGE
                 Could not find any versions of service "#{e.service}".
                 Please double-check that you have deployed this service. If you want to run
-                a command against a different service, you may provide a GAE_CONFIG argument
-                pointing to your App Engine config file, or a GAE_SERVICE argument to specify
-                a service directly.
+                a command against a different service, you may provide a EXEC_APP_CONFIG
+                argument pointing to your App Engine config file, or a EXEC_SERVICE_NAME
+                argument to specify a service directly.
               MESSAGE
             end
           rescue Exec::NoDefaultProject
@@ -361,15 +382,15 @@ module Google
               Could not get the default project from gcloud.
               Please either set the current project using
                 gcloud config set project my-project-id
-              or specify the project by setting the GAE_PROJECT argument. e.g.
-                bundle exec rake serverless:exec GAE_PROJECT=my-project-id -- myscript.sh
+              or specify the project by setting the EXEC_PROJECT argument. e.g.
+                bundle exec rake serverless:exec EXEC_PROJECT=my-project-id -- myscript.sh
             MESSAGE
           rescue Exec::UsageError => e
             report_error e.message
           end
           def report_error str
-            ::STDERR.puts str
+            warn str
             exit 1
           end
         end

data/lib/google/serverless/exec/version.rb CHANGED Viewed

@@ -18,7 +18,7 @@ module Google
   module Serverless
     class Exec
       # The current version of this gem, as a string.
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/google/serverless/exec.rb CHANGED Viewed

@@ -202,7 +202,7 @@ module Google
     # used. (Note that this most recently deployed version may not be the same
     # version that is currently receiving traffic: for example, if you deployed
     # with `--no-promote`.) To use a different version, set the `version`
-    # parameter in the {Google::Serverless::Exec} constructor
+    # parameter in the {Google::Serverless::Exec} constructor
     # (or the corresponding `GAE_VERSION` parameter in the Rake task).
     #
     # ### Providing credentials
@@ -253,13 +253,13 @@ module Google
       APP_ENGINE = :app_engine
       CLOUD_RUN = :cloud_run
       ##
       # Base class for exec-related usage errors.
       #
       class UsageError < ::StandardError
       end
       ##
       # Unsupported strategy
       #
@@ -273,7 +273,7 @@ module Google
         attr_reader :strategy
         attr_reader :app_env
       end
       ##
       # Exception raised when a parameter is malformed.
       #
@@ -286,7 +286,7 @@ module Google
         attr_reader :param_name
         attr_reader :value
       end
       ##
       # Exception raised when gcloud has no default project.
       #
@@ -295,7 +295,7 @@ module Google
           super "No default project set."
         end
       end
       ##
       # Exception raised when the App Engine config file could not be found.
       #
@@ -306,7 +306,7 @@ module Google
         end
         attr_reader :config_path
       end
       ##
       # Exception raised when the App Engine config file could not be parsed.
       #
@@ -317,7 +317,7 @@ module Google
         end
         attr_reader :config_path
       end
       ##
       # Exception raised when the given version could not be found, or no
       # versions at all could be found for the given service.
@@ -335,20 +335,20 @@ module Google
         attr_reader :service
         attr_reader :version
       end
       class << self
         ## @return [String] Default command timeout.
         attr_accessor :default_timeout
         ## @return [String] Default service name if the config doesn't specify.
         attr_accessor :default_service
         ## @return [String] Path to default config file.
         attr_accessor :default_config_path
         ## @return [String] Docker image that implements the app engine wrapper.
         attr_accessor :default_wrapper_image
         ##
         # Create an execution for a rake task.
         #
@@ -397,7 +397,7 @@ module Google
               strategy: strategy, gcs_log_dir: gcs_log_dir, product: product
         end
       end
       ##
       # Create an execution for the given command.
       #
@@ -427,10 +427,20 @@ module Google
       # @param product [Symbol] The serverless product. If omitted, defaults to the
       #     value returns by {Google::Serverless::Exec#default_product}.
       #     Allowed values are {APP_ENGINE} and {CLOUD_RUN}.
+      # @param region [String] The region for the cloud run service. Required
+      #     if the product is cloud run.
       #
       def initialize command,
-                     project: nil, service: nil, config_path: nil, version: nil,
-                     timeout: nil, wrapper_image: nil, strategy: nil, gcs_log_dir: nil, product: nil
+                     project: nil,
+                     service: nil,
+                     config_path: nil,
+                     version: nil,
+                     timeout: nil,
+                     wrapper_image: nil,
+                     strategy: nil,
+                     gcs_log_dir: nil,
+                     product: nil,
+                     region: nil
         @command = command
         @service = service
         @config_path = config_path
@@ -441,40 +451,41 @@ module Google
         @strategy = strategy
         @gcs_log_dir = gcs_log_dir
         @product = product
+        @region = region
         yield self if block_given?
       end
       ##
       # @return [String] The project ID.
       # @return [nil] if the default gcloud project should be used.
       #
       attr_accessor :project
       ##
       # @return [String] The service name.
       # @return [nil] if the service should be obtained from the app config.
       #
       attr_accessor :service
       ##
       # @return [String] Path to the config file.
       # @return [nil] if the default of `./app.yaml` should be used.
       #
       attr_accessor :config_path
       ##
       # @return [String] Service version of the image to use.
       # @return [nil] if the most recent should be used.
       #
       attr_accessor :version
       ##
       # @return [String] The command timeout, in `1h23m45s` format.
       # @return [nil] if the default of `10m` should be used.
       #
       attr_accessor :timeout
       ##
       # The command to run.
       #
@@ -483,13 +494,13 @@ module Google
       #     directly without a shell.
       #
       attr_accessor :command
       ##
       # @return [String] Custom wrapper image to use.
       # @return [nil] if the default should be used.
       #
       attr_accessor :wrapper_image
       ##
       # @return [String] The execution strategy to use. Allowed values are
       #     `"deployment"` and `"cloud_build"`.
@@ -503,11 +514,16 @@ module Google
       #     Allowed values are {APP_ENGINE} and {CLOUD_RUN}
       #
       attr_accessor :product
+      ##
+      # @return [String] The region for the cloud run service
+      #
+      attr_accessor :region
       ##
       # Executes the command synchronously. Streams the logs back to standard out
       # and does not return until the command has completed or timed out.
       def start
         resolve_parameters
         case @product
@@ -532,9 +548,9 @@ module Google
         app_info = version_info_cloud_run @service
         start_build_strategy app_info
       end
       private
       ##
       # @private
       # Resolves and canonicalizes all the parameters.
@@ -553,7 +569,7 @@ module Google
         end
         self
       end
       def resolve_strategy app_env
         @strategy = @strategy.to_s.downcase
         if @strategy.empty?
@@ -565,7 +581,7 @@ module Google
         end
         @strategy
       end
       def service_from_config
         return nil if !@config_path && @service
         @config_path ||= Exec.default_config_path
@@ -575,7 +591,7 @@ module Google
       rescue ::StandardError
         raise BadConfigFileFormat, @config_path
       end
       def default_project
         result = Exec::Gcloud.execute \
           ["config", "get-value", "project"],
@@ -588,7 +604,7 @@ module Google
       def default_product
         File.file?("app.yaml") ? APP_ENGINE : CLOUD_RUN
       end
       def parse_timeout timeout_str
         matched = timeout_str =~ /^(?:(\d+)h)?(?:(\d+)m)?(?:(\d+)s?)?$/
         raise BadParameter.new "timeout", timeout_str unless matched
@@ -597,7 +613,7 @@ module Google
         seconds = ::Regexp.last_match(3).to_i
         hours * 3600 + minutes * 60 + seconds
       end
       ##
       # @private
       # Returns the name of the most recently created version of the given
@@ -621,7 +637,7 @@ module Google
         raise NoSuchVersion, service unless result
         result
       end
       ##
       # @private
       # Returns full information on the given version of the given service.
@@ -652,16 +668,19 @@ module Google
       def version_info_cloud_run service
         service ||= "default"
+        raise BadParameter.new("region", "(value missing)") unless region
         result = Exec::Gcloud.execute \
           [
             "run", "services", "describe", service,
+            "--project", @project,
+            "--region", region,
             "--format", "json"
           ],
-          capture: true, assert: false
+          capture: true, assert: false, echo: true
         result.strip!
         ::JSON.parse result
       end
       ##
       # @private
       # Performs exec on a GAE standard app.
@@ -686,7 +705,7 @@ module Google
           delete_temp_version temp_version
         end
       end
       def describe_deployment_strategy
         puts "\nUsing the `deployment` strategy for serverless:exec"
         puts "(i.e. deploying a temporary version of your app)"
@@ -694,15 +713,14 @@ module Google
         puts "SERVICE: #{@service}"
         puts "TIMEOUT: #{@timeout}"
       end
       def create_secret
         ::SecureRandom.alphanumeric 20
       end
       def copy_entrypoint secret
-        entrypoint_template =
-          ::File.join(::File.dirname(::File.dirname(__dir__)),
-                      "data", "exec_standard_entrypoint.rb.erb")
+        base_dir = ::File.dirname ::File.dirname ::File.dirname __dir__
+        entrypoint_template = ::File.join base_dir, "data", "exec_standard_entrypoint.rb.erb"
         entrypoint_file = "appengine_exec_entrypoint_#{@timestamp_suffix}.rb"
         erb = ::ERB.new ::File.read entrypoint_template
         data = {
@@ -714,7 +732,7 @@ module Google
         end
         entrypoint_file
       end
       def copy_app_yaml app_info, entrypoint_file
         yaml_data = {
           "runtime"        => app_info["runtime"],
@@ -734,7 +752,7 @@ module Google
         end
         app_yaml_file
       end
       def complete_flex_app_yaml yaml_data, app_info
         yaml_data["env"] = "flex"
         orig_path = (app_info["betaSettings"] || {})["module_yaml_path"]
@@ -746,11 +764,11 @@ module Google
           yaml_data[key] = orig_yaml[key] if orig_yaml[key]
         end
       end
       def complete_standard_app_yaml yaml_data, app_info
         yaml_data["instance_class"] = app_info["instanceClass"].sub(/^F/, "B")
       end
       def deploy_temp_app app_yaml_file
         temp_version = "appengine-exec-#{@timestamp_suffix}"
         Exec::Gcloud.execute [
@@ -761,7 +779,7 @@ module Google
         ]
         temp_version
       end
       def track_status temp_version, secret
         host = "#{temp_version}.#{@service}.#{@project}.appspot.com"
         ::Net::HTTP.start host do |http|
@@ -791,7 +809,7 @@ module Google
           end
         end
       end
       def delete_temp_version temp_version
         Exec::Gcloud.execute [
           "app", "versions", "delete", temp_version,
@@ -800,7 +818,7 @@ module Google
           "--quiet"
         ]
       end
       ##
       # @private
       # Performs exec on a GAE flexible and Cloud Run apps.
@@ -820,9 +838,9 @@ module Google
           cloud_sql_instances = metadata_annotations["run.googleapis.com/cloudsql-instances"] || []
           image = metadata_annotations["client.knative.dev/user-image"]
         end
         describe_build_strategy
         config = build_config command, image, env_variables, cloud_sql_instances
         file = ::Tempfile.new ["cloudbuild_", ".json"]
         begin
@@ -841,7 +859,7 @@ module Google
           file.close!
         end
       end
       ##
       # @private
       # Workaround for https://github.com/GoogleCloudPlatform/appengine-ruby/issues/33
@@ -866,7 +884,7 @@ module Google
         build_info = ::JSON.parse(result).first
         build_info["images"].first
       end
       def describe_build_strategy
         puts "\nUsing the `cloud_build` strategy for serverless:exec"
         puts "(i.e. running your app image in Cloud Build)"
@@ -876,7 +894,7 @@ module Google
         puts "TIMEOUT: #{@timeout}"
         puts ""
       end
       ##
       # @private
       # Builds a cloudbuild config as a data structure.
@@ -901,7 +919,7 @@ module Google
         end
         args << "--"
         args += command
         {
           "steps" => [
             "name" => @wrapper_image,

data/lib/google-serverless-exec.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# Copyright 2021 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
+#
+#     http://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 "google/serverless/exec"
+require "google/serverless/exec/railtie" if defined? ::Rails

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-serverless-exec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -123,20 +109,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: toys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -151,12 +123,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: " The google-serverless-exec gem is a set of classes, plugins, and tools
-  for integration with Google Serverless compute. It provides access to the runtime
-  environments, including logging to the Google Cloud Console and interrogation of
-  hosting properties. It also provides Rake tasks for managing your serverless applications,
-  for example to run production maintenance commands such as database migrations.
-  This gem is NOT required to deploy your Ruby application to Google Serverless compute."
+description: The google-serverless-exec gem provides a way to safely run production
+  maintenance tasks, such as database migrations, for your serverless applications
+  deployed to Google App Engine or Google Cloud Run.
 email:
 - dazuma@gmail.com
 - trambui09098@gmail.com
@@ -169,14 +138,21 @@ files:
 - CONTRIBUTING.md
 - LICENSE
 - README.md
+- data/exec_standard_entrypoint.rb.erb
+- lib/google-serverless-exec.rb
 - lib/google/serverless/exec.rb
 - lib/google/serverless/exec/gcloud.rb
+- lib/google/serverless/exec/railtie.rb
 - lib/google/serverless/exec/tasks.rb
 - lib/google/serverless/exec/version.rb
 homepage: https://github.com/GoogleCloudPlatform/serverless-exec-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://www.rubydoc.info/gems/google-serverless-exec/0.2.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/GoogleCloudPlatform/serverless-exec-ruby
+  bug_tracker_uri: https://github.com/GoogleCloudPlatform/serverless-exec-ruby/issues
+  documentation_uri: https://www.rubydoc.info/gems/google-serverless-exec/0.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -185,15 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
-summary: Google Cloud integration tools
+summary: Execute production tasks for Google Serverless apps
 test_files: []