Merge pull request #369 from appsignal/environment-switching-param

Switch environments with an `env=<name>` parameter

Author: unflxw

.gitignore

@@ -4,6 +4,7 @@
 nodejs/opentelemetry-instrumentation-bullmq
 .DS_Store
 appsignal_key.env
+appsignal_key.*.env
 .env
 yarn-error.log
 node_modules

README.md

@@ -13,11 +13,32 @@ Next, checkout the integrations locally:
 rake integrations:clone
 ```
 
-Generate an environment file using a valid push api key you
-can get on [AppSignal](https://appsignal.com):
+Pick the environment to send data to. The `local` and `staging` environments
+work out of the box:
 
 ```
-rake global:set_push_api_key key=<key>
+rake env:local
+rake env:staging
+```
+
+Switching writes an `appsignal_key.<name>.env` file (seeded from a committed
+`appsignal_key.<name>.env.example` default when there is one) and copies it into
+`appsignal_key.env`, the file every test setup reads, tagging it with an
+`# ENV: <name>` marker. The active environment's contents are printed on boot,
+so you can always see which one is in use.
+
+Pass a push api key (you can get one on [AppSignal](https://appsignal.com)) to
+set it for that environment while switching; it's remembered on later switches:
+
+```
+rake env:prod key=<key>
+```
+
+`env:local`, `env:staging` and `env:prod` are shortcuts for the general form,
+which works for any environment name:
+
+```
+rake env=<name> key=<key> env:switch
 ```
 
 To start a test setup:

Rakefile

@@ -4,13 +4,76 @@ require 'fileutils'
 LANGUAGES = %w(elixir go java javascript nodejs php python ruby standalone vector)
 PROCESSMON_PATH = "support/processmon/processmon"
 
+# The active environment file every test setup reads. It's written by
+# `env:switch` from a per-environment `appsignal_key.<name>.env` file, with an
+# `# ENV: <name>` marker line prepended so the active environment is visible in
+# the file itself (it's also printed on boot).
+ACTIVE_KEY_FILE = "appsignal_key.env"
+
 def get_app
   ENV['app'].tap do |app|
     raise "Specify which app you want to run using app=path" if app.nil?
     raise "#{app} not found" unless File.exist?(app)
   end.delete_suffix("/")
 end
 
+# The environment name from the `env=` parameter, e.g. `prod` for
+# `appsignal_key.prod.env`.
+def get_env
+  ENV['env'].tap do |name|
+    raise "Specify which environment you want using env=<name>" if name.nil? || name.strip.empty?
+  end.strip
+end
+
+# The per-environment key file that `env=<name>` selects.
+def env_key_file(name)
+  "appsignal_key.#{name}.env"
+end
+
+# A committed default for an environment, copied into the per-environment file
+# the first time you switch to it. `local` and `staging` ship one; other
+# environments start from whatever key you pass.
+def default_env_file(name)
+  "#{env_key_file(name)}.example"
+end
+
+# Set the push api key in a key file, replacing an existing
+# `APPSIGNAL_PUSH_API_KEY` line if present and leaving the rest of the file
+# (endpoints and so on) untouched. Creates the file if it doesn't exist.
+def set_push_api_key(file, key)
+  var = "APPSIGNAL_PUSH_API_KEY"
+  lines = File.exist?(file) ? File.readlines(file, :chomp => true) : []
+  replaced = false
+  lines.map! do |line|
+    next line unless line.start_with?("#{var}=")
+    replaced = true
+    "#{var}=#{key}"
+  end
+  lines << "#{var}=#{key}" unless replaced
+  File.write file, lines.join("\n") + "\n"
+end
+
+# Make `name` the active environment: seed its key file from the committed
+# default if needed, set the key when one is given, then copy it into
+# `appsignal_key.env` with an `# ENV: <name>` marker.
+def switch_env(name, key = nil)
+  source = env_key_file(name)
+
+  if !File.exist?(source) && File.exist?(default_env_file(name))
+    puts "Creating #{source} from #{default_env_file(name)}"
+    FileUtils.cp default_env_file(name), source
+  end
+
+  set_push_api_key(source, key) if key
+
+  unless File.exist?(source)
+    raise "No #{source} found. Provide a key to create it, e.g. rake env=#{name} key=<key> env:switch"
+  end
+
+  File.write ACTIVE_KEY_FILE, "# ENV: #{name}\n#{File.read(source)}"
+  puts "Switched active environment to '#{name}'."
+end
+
 # A mode is just a `docker-compose.<mode>.yml` file in the app directory. The
 # `shared` file is reserved (it holds the common services every mode includes)
 # and is never a selectable mode. Returns a `{ mode_name => filename }` map.
@@ -167,6 +230,28 @@ def render_erb(file)
   ERB.new(File.read(file)).result
 end
 
+namespace :env do
+  desc "Switch the active environment, e.g. rake env=prod env:switch (pass key=<key> to also set its key)"
+  task :switch do
+    switch_env(get_env, ENV['key'])
+  end
+
+  desc "Switch to the local environment (pass key=<key> to also set its key)"
+  task :local do
+    switch_env("local", ENV['key'])
+  end
+
+  desc "Switch to the staging environment (pass key=<key> to also set its key)"
+  task :staging do
+    switch_env("staging", ENV['key'])
+  end
+
+  desc "Switch to the production environment (pass key=<key> to also set its key)"
+  task :prod do
+    switch_env("prod", ENV['key'])
+  end
+end
+
 namespace :app do
   desc "Open the browser pointing to the app"
   task :open do
@@ -203,8 +288,8 @@ namespace :app do
   end
 
   def build_app
-    unless File.exist?("appsignal_key.env")
-      raise "No push api key set yet, run rake global:set_push_api_key key=<key>"
+    unless File.exist?(ACTIVE_KEY_FILE)
+      raise "No active environment set yet, run e.g. rake env:local or rake env=<name> key=<key> env:switch"
     end
     unless File.exist?(PROCESSMON_PATH)
       puts "Processmon not present. Building processmon..."
@@ -215,6 +300,10 @@ namespace :app do
     @mode = get_mode(@app)
     puts "Starting #{@app}"
 
+    puts "=" * 50
+    puts File.read(ACTIVE_KEY_FILE)
+    puts "=" * 50
+
     puts "Copying processmon"
     FileUtils.rm_f "#{@app}/commands/processmon"
     FileUtils.cp "support/processmon/processmon", "#{@app}/commands/"
@@ -433,13 +522,6 @@ namespace :global do
     File.write "README.md", render_erb("support/templates/README.md.erb")
   end
 
-  desc "Set the push api key to use"
-  task :set_push_api_key do
-    @key = ENV['key'] or raise "No key provided"
-    puts "Setting push api key in appsignal_key.env"
-    File.write "appsignal_key.env", render_erb("support/templates/appsignal_key.env.erb")
-  end
-
   desc "Install bundled processmon"
   task :install_processmon do
     run_command("cd support/processmon && ./build.sh")

appsignal_key.local.env.example

@@ -0,0 +1,3 @@
+APPSIGNAL_PUSH_API_KEY=00000000-0000-0000-0000-000000000000
+APPSIGNAL_PUSH_API_ENDPOINT=http://host.docker.internal:5001
+APPSIGNAL_LOGGING_ENDPOINT=http://host.docker.internal:5002

appsignal_key.staging.env.example

@@ -0,0 +1,2 @@
+APPSIGNAL_PUSH_API_ENDPOINT=https://push.staging.lol/
+APPSIGNAL_LOGGING_ENDPOINT=https://error-tracker.staging.lol/

support/templates/README.md.erb

@@ -13,11 +13,32 @@ Next, checkout the integrations locally:
 rake integrations:clone
 ```
 
-Generate an environment file using a valid push api key you
-can get on [AppSignal](https://appsignal.com):
+Pick the environment to send data to. The `local` and `staging` environments
+work out of the box:
 
 ```
-rake global:set_push_api_key key=<key>
+rake env:local
+rake env:staging
+```
+
+Switching writes an `appsignal_key.<name>.env` file (seeded from a committed
+`appsignal_key.<name>.env.example` default when there is one) and copies it into
+`appsignal_key.env`, the file every test setup reads, tagging it with an
+`# ENV: <name>` marker. The active environment's contents are printed on boot,
+so you can always see which one is in use.
+
+Pass a push api key (you can get one on [AppSignal](https://appsignal.com)) to
+set it for that environment while switching; it's remembered on later switches:
+
+```
+rake env:prod key=<key>
+```
+
+`env:local`, `env:staging` and `env:prod` are shortcuts for the general form,
+which works for any environment name:
+
+```
+rake env=<name> key=<key> env:switch
 ```
 
 To start a test setup: