Merge pull request #785 from bitcoin-dev-project/pod-limit

Establish limit of 100 pods per namespace in war game, configurable in yaml

Author: pinheadmz

resources/charts/namespaces/templates/namespace.yaml

@@ -2,3 +2,12 @@ apiVersion: v1
 kind: Namespace
 metadata:
   name: {{ .Values.namespaceName | default .Release.Name }}
+---
+apiVersion: v1
+kind: ResourceQuota
+metadata:
+  name: namespace-pod-limit
+  namespace: {{ .Values.namespaceName | default .Release.Name }}
+spec:
+  hard:
+    pods: {{ .Values.podLimit | quote }}

resources/charts/namespaces/values.yaml

@@ -58,3 +58,4 @@ roles:
       - apiGroups: ["networking.k8s.io"]
         resources: ["ingresses"]
         verbs: ["list", "get", "watch"]
+podLimit: 100

resources/scenarios/test_scenarios/nothing.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+from time import sleep
+
+# The base class exists inside the commander container
+try:
+    from commander import Commander
+except Exception:
+    from resources.scenarios.commander import Commander
+
+
+class Nothing(Commander):
+    def set_test_params(self):
+        self.num_nodes = 1
+
+    def add_options(self, parser):
+        parser.description = "This test will do nothing, forever"
+        parser.usage = "warnet run /path/to/nothing.py"
+
+    def run_test(self):
+        while True:
+            sleep(60)
+
+
+def main():
+    Nothing("").main()
+
+
+if __name__ == "__main__":
+    main()

test/data/wargames/namespaces/armies/namespace-defaults.yaml

@@ -3,3 +3,4 @@ users:
     roles:
       - pod-viewer
       - pod-manager
+podLimit: 3

test/test_base.py

@@ -3,12 +3,15 @@
 import logging.config
 import os
 import re
+import sys
 import threading
 from pathlib import Path
 from subprocess import run
 from tempfile import mkdtemp
 from time import sleep
 
+import pexpect
+
 from warnet import SRC_DIR
 from warnet.k8s import get_pod_exit_status
 from warnet.network import _connected as network_connected
@@ -45,7 +48,10 @@ def cleanup(self, signum=None, frame=None):
         try:
             self.log.info("Stopping network")
             if self.network:
-                self.warnet("down --force")
+                session = pexpect.spawn("warnet down", encoding="utf-8")
+                session.logfile = sys.stdout
+                session.expect("Do you want to bring down the running Warnet?", timeout=30)
+                session.sendline("y")
                 self.wait_for_all_tanks_status(target="stopped", timeout=60, interval=1)
         except Exception as e:
             self.log.error(f"Error bringing network down: {e}")

test/wargames_test.py

@@ -8,6 +8,7 @@
 
 from warnet.k8s import get_kubeconfig_value
 from warnet.process import stream_command
+from warnet.status import _get_deployed_scenarios as scenarios_deployed
 
 
 class WargamesTest(TestBase):
@@ -19,6 +20,7 @@ def __init__(self):
             Path(os.path.dirname(__file__)).parent / "resources" / "scenarios" / "test_scenarios"
         )
         self.initial_context = get_kubeconfig_value("{.current-context}")
+        self.kconfigdir = self.tmpdir / "kubeconfigs"
 
     def run_test(self):
         try:
@@ -61,8 +63,10 @@ def check_scenario_permissions(self):
         assert self.warnet("bitcoin rpc miner getblockcount") == "5"
 
         self.log.info("Switch to wargames player context")
-        self.log.info(self.warnet("admin create-kubeconfigs"))
-        clicker = pexpect.spawn("warnet auth kubeconfigs/warnet-user-wargames-red-kubeconfig")
+        self.log.info(self.warnet(f"admin create-kubeconfigs --kubeconfig-dir={self.kconfigdir}"))
+        clicker = pexpect.spawn(
+            f"warnet auth {self.kconfigdir}/warnet-user-wargames-red-kubeconfig"
+        )
         while clicker.expect(["Overwrite", "Updated kubeconfig"]) == 0:
             print(clicker.before, clicker.after)
             clicker.sendline("y")
@@ -82,16 +86,24 @@ def check_scenario_permissions(self):
         # Nothing was accesible
         assert self.warnet("bitcoin rpc armada getblockcount") == "6"
 
+        self.log.info("Check pod limit per namespace")
+        for _ in range(10):
+            stream_command(
+                f"warnet run {self.scen_test_dir / 'nothing.py'} --source_dir={self.scen_src_dir}"
+            )
+        assert len(scenarios_deployed()) == 2, (
+            f"Unexpected scenarios deployed:{scenarios_deployed()}"
+        )
+
         self.log.info("Restore admin context")
         stream_command(f"kubectl config use-context {self.initial_context}")
         # Sanity check
         assert self.warnet("bitcoin rpc miner getblockcount") == "6"
 
         self.log.info("Re-generate kubeconfigs after a scenario has been run")
-        self.log.info(self.warnet("admin create-kubeconfigs"))
-        kubeconfig_dir = Path("kubeconfigs/")
+        self.log.info(self.warnet(f"admin create-kubeconfigs --kubeconfig-dir={self.kconfigdir}"))
         count = 0
-        for p in kubeconfig_dir.iterdir():
+        for p in self.kconfigdir.iterdir():
             if p.is_file():
                 print(p)
                 assert "warnet-user" in str(p)