Get rid of circuit breaker, which just causes an (on-purpose) failure that confuses people

Author: JoshuaFox

README.md

@@ -225,13 +225,6 @@ examples.
      * The name of this role is `iris3`by default, but may be set by passing env variable `IRIS_CUSTOM_ROLE` in calling `deploy.sh` or `uninstall.sh`
 
 # Testing
-## Circuit-breaker
-Warning: A circuit breaker will cause scheduled labeling to fail with an exception if you are running in "development/test mode" and scheduled-labeling finds more than 3 projects to label. This is meant to protect from accidentally flooding thousands of projects with labels when you are testing. (Though if so, the worst that happens is some useful labels 😉 )
-
-  * "Development/test mode" means that at least one of these is true:
-    * The project ID has in it `dev`, `qa`, `playground`, or `test`, or whatever is configured. You can change or remove these strings in the configuration under key `test_or_dev_project_markers`)
-    * or `config-test.yaml` exists, so that Iris is using it rather than `config.yaml`
-    * or Iris is running in your local machine (rather than App Engine)
 
 ## Integration test
 
@@ -240,19 +233,6 @@ Warning: A circuit breaker will cause scheduled labeling to fail with an excepti
 * It's an easy sanity check to be sure that, for example, that you have the right permissions.
 * It works against two test projects that you specify.
 
-## Testing the Cloud Scheduler scheduled labeling
-
-- This testing is less automated than `integration_test.sh`, so do it only if you have special need to test this functionality.
-- Deploy some cloud resources like Cloud SQL instance. Or deploy an unattached disk and attach it.
-- Configuration
-    * Optionally edit the configuration file to set `label_all_on_cron: True` or `False`.
-      * `True` will cause all resources to be labeled on the Cloud Scheduler cron job, 
-      * and `False` will cause only Cloud SQL and GCE Disks to be labeled.
-    * Edit the configuration file to set `iris_prefix` to a unique value, so you can track the labels generated by this test.
-- Deploy the app
-    * Use the `-c` switch at the end of the line (after the project ID). This disables event-based labeling, keeping only the Cloud Scheduler cron functionality.
-    * Trigger Cloud Scheduler from the App Engine GUI, and check that labels were added.
-
 # Next steps
 
 See `TODO.md` and GitHub issues for potential future improvements.

main.py

@@ -74,50 +74,13 @@ def index():
     increment_invocation_count("index")
     with gae_memory_logging("index"):
         msg = iris_homepage_text()
-        if dev_or_test_mode():
-            msg += "\nI'm running in test or dev mode. " + explain_dev_or_test_mode()
 
         logging.info(
             "index(); invocations of GAE instance : %s", count_invocations_by_path()
         )
         return Response(msg, mimetype="text/plain", status=200)
 
 
-from util.config_utils import (
-    is_in_test_or_dev_project,
-    is_test_configuration,
-    config_test_file,
-)
-from util.gcp.detect_gae import detect_gae
-from util.gcp.gcp_utils import current_project_id
-
-
-def dev_or_test_mode():
-    return (
-        not detect_gae()
-        or is_test_configuration()
-        or is_in_test_or_dev_project(current_project_id())
-    )
-
-
-def explain_dev_or_test_mode():
-    explain = []
-    if not detect_gae():
-        explain.append("Not running in App Engine")
-    if is_test_configuration():
-        explain.append("Using a test configuration file " + config_test_file())
-    if is_in_test_or_dev_project(current_project_id()):
-        explain.append(
-            "Running a project "
-            + current_project_id()
-            + " which has one of the markers of a test project"
-            + " configured under key test_or_dev_project_markers"
-        )
-    if not explain:
-        explain.append("NOT in dev or test mode")
-    return "; ".join(explain)
-
-
 @app.route("/_ah/warmup")
 def warmup():
     increment_invocation_count("warmup")
@@ -175,26 +138,9 @@ def __get_enabled_projects():
     if not enabled_projs:
         raise Exception("No projects enabled at all")
 
-    __circuit_breaker_in_devmode(enabled_projs)  # Can throw exception
     return enabled_projs
 
 
-def __circuit_breaker_in_devmode(enabled_projs):
-    if dev_or_test_mode():
-        max_proj_in_dev = 8
-        if len(enabled_projs) > max_proj_in_dev:
-            raise Exception(
-                "When running Iris in development/testing mode, "
-                + f"we support no more than "
-                + str(max_proj_in_dev)
-                + " projects, to avoid accidentally flooding the system. "
-                + str(len(enabled_projs))
-                + " projects are available, which exceeds that. "
-                + "This server is in development/testing mode because: "
-                + explain_dev_or_test_mode()
-            )
-
-
 def __send_pubsub_per_projectplugin(configured_projects):
     msg_count = 0
     for project_id in configured_projects:

test_scripts/integration_test.py

@@ -419,5 +419,5 @@ def create_resources(test_project, run_id, gce_zone):
     assert_root_path()
 
     main()
-    print("Status", "failure" if global_exit_code else "success")
+    print("Exit Status:", "failure" if global_exit_code else "success")
     sys.exit(global_exit_code)

uninstall.sh

@@ -65,6 +65,9 @@ while getopts 'poh' opt; do
                   This is useful if you deployed Iris to two projects
                   in an org and want to delete it on one of those.
                   -o: Uninstall org-level elements like Log Sink
+            Environment variable:
+                  IRIS_CUSTOM_ROLE (Optional, default is iris3) An identifier for
+                  the Iris custom role that you want to delete.
 EOF
     exit 1
     ;;

util/config_utils.py

@@ -104,11 +104,3 @@ def is_test_configuration():
 
 def config_test_file():
     return get_config()["config_file"]
-
-
-def is_in_test_or_dev_project(project_id):
-    markers = get_config().get("test_or_dev_project_markers", [])
-    for marker in markers:
-        if marker and marker in project_id:
-            return True
-    return False