From 47d840f85696829b79b90913b076ba94f71c584d Mon Sep 17 00:00:00 2001
From: Sean Rankine <sean.rankine@me.com>
Date: Wed, 5 Jun 2024 16:33:47 +0100
Subject: [PATCH] Use GOVUK_ENVIRONMENT instead of GOVUK_ENVIRONMENT_NAME

Both environment variables are set to the same value. GOVUK_ENVIRONMENT
is used more frequently, renaming for consistency.
---
 Dockerfile                              | 2 +-
 app/models/govuk_environment.rb         | 2 +-
 docs/environment-variables.md           | 2 +-
 lib/healthcheck/api_tokens.rb           | 2 +-
 test/lib/healthcheck/api_tokens_test.rb | 2 +-
 test/models/govuk_environment_test.rb   | 8 ++++----
 test/test_helper.rb                     | 2 +-
 7 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 188b7c3a5..f75b28e1e 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -7,7 +7,7 @@ FROM --platform=$TARGETPLATFORM $builder_image AS builder
 
 ENV DEVISE_PEPPER=unused \
     DEVISE_SECRET_KEY=unused \
-    GOVUK_ENVIRONMENT_NAME=unused
+    GOVUK_ENVIRONMENT=unused
 
 WORKDIR $APP_HOME
 COPY Gemfile* .ruby-version ./
diff --git a/app/models/govuk_environment.rb b/app/models/govuk_environment.rb
index 4f7298e38..d994d2aa0 100644
--- a/app/models/govuk_environment.rb
+++ b/app/models/govuk_environment.rb
@@ -3,7 +3,7 @@ def self.name
     if Rails.env.development? || Rails.env.test?
       "development"
     else
-      ENV.fetch("GOVUK_ENVIRONMENT_NAME")
+      ENV.fetch("GOVUK_ENVIRONMENT")
     end
   end
 
diff --git a/docs/environment-variables.md b/docs/environment-variables.md
index fe16c1517..dbcabbfdf 100644
--- a/docs/environment-variables.md
+++ b/docs/environment-variables.md
@@ -38,4 +38,4 @@ Used to configure Google Analytics in the new `app/views/layouts/admin_layout.ht
 
 Used to configure `GovukAdminTemplate` and in `Healthcheck::ApiTokens#expiring_tokens`.
 
-* `GOVUK_ENVIRONMENT_NAME`
+* `GOVUK_ENVIRONMENT`
diff --git a/lib/healthcheck/api_tokens.rb b/lib/healthcheck/api_tokens.rb
index df27a88cd..bea98b607 100644
--- a/lib/healthcheck/api_tokens.rb
+++ b/lib/healthcheck/api_tokens.rb
@@ -19,7 +19,7 @@ class ApiTokens
         ) tokens
       INNER JOIN users ON users.id = tokens.resource_owner_id
       WHERE tokens.revoked_at IS NULL
-      AND users.email NOT LIKE '%@#{ENV['GOVUK_ENVIRONMENT_NAME']}.publishing.service.gov.uk'
+      AND users.email NOT LIKE '%@#{ENV['GOVUK_ENVIRONMENT']}.publishing.service.gov.uk'
       AND users.name NOT LIKE '%[EKS]'
       AND users.api_user = TRUE
       AND tokens.expires_in < #{WARNING_THRESHOLD}
diff --git a/test/lib/healthcheck/api_tokens_test.rb b/test/lib/healthcheck/api_tokens_test.rb
index 934d07129..87cb218dd 100644
--- a/test/lib/healthcheck/api_tokens_test.rb
+++ b/test/lib/healthcheck/api_tokens_test.rb
@@ -8,7 +8,7 @@ class PermissionUpdaterTest < ActiveSupport::TestCase
     end
 
     should "return 'OK' when tokens for @<env>.publishing.service.gov.uk are expiring" do
-      user = create(:api_user, email: "#{random_str}@#{ENV['GOVUK_ENVIRONMENT_NAME']}.publishing.service.gov.uk")
+      user = create(:api_user, email: "#{random_str}@#{ENV['GOVUK_ENVIRONMENT']}.publishing.service.gov.uk")
 
       make_api_user_token(
         expires_in: Healthcheck::ApiTokens::WARNING_THRESHOLD,
diff --git a/test/models/govuk_environment_test.rb b/test/models/govuk_environment_test.rb
index 50cec20fe..91a516ba8 100644
--- a/test/models/govuk_environment_test.rb
+++ b/test/models/govuk_environment_test.rb
@@ -30,14 +30,14 @@ class GovukEnvironmentTest < ActionMailer::TestCase
         Rails.env.stubs(:test?).returns(false)
       end
 
-      should "return value of GOVUK_ENVIRONMENT_NAME if it is set" do
-        ClimateControl.modify(GOVUK_ENVIRONMENT_NAME: "govuk-environment-name") do
+      should "return value of GOVUK_ENVIRONMENT if it is set" do
+        ClimateControl.modify(GOVUK_ENVIRONMENT: "govuk-environment-name") do
           assert_equal "govuk-environment-name", GovukEnvironment.name
         end
       end
 
-      should "fail fast if GOVUK_ENVIRONMENT_NAME is not set" do
-        ClimateControl.modify(GOVUK_ENVIRONMENT_NAME: nil) do
+      should "fail fast if GOVUK_ENVIRONMENT is not set" do
+        ClimateControl.modify(GOVUK_ENVIRONMENT: nil) do
           assert_raises(KeyError) { GovukEnvironment.name }
         end
       end
diff --git a/test/test_helper.rb b/test/test_helper.rb
index ae577cf55..995c96935 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -1,5 +1,5 @@
 ENV["RAILS_ENV"] = "test"
-ENV["GOVUK_ENVIRONMENT_NAME"] = "test"
+ENV["GOVUK_ENVIRONMENT"] = "test"
 
 require "simplecov"
 SimpleCov.start "rails"