Include link to wiki page in scheduler deprecation warning message

Signed-off-by: Tim Lane <[email protected]>

Author: Tim Lane

cli/pcluster/config/validators.py

@@ -746,10 +746,11 @@ def scheduler_validator(param_key, param_value, pcluster_config):
         errors.append("'{0}' scheduler supports the following Operating Systems: {1}".format(param_value, supported_os))
 
     will_be_deprecated = ["sge", "torque"]
+    wiki_url = "https://github.com/aws/aws-parallelcluster/wiki/Deprecation-of-SGE-and-Torque-in-ParallelCluster"
     if param_value in will_be_deprecated:
         warnings.append(
             "The job scheduler you are using ({0}) is scheduled to be deprecated in future releases of "
-            "ParallelCluster".format(param_value)
+            "ParallelCluster. More information is available here: {1}".format(param_value, wiki_url)
         )
 
     return errors, warnings

cli/tests/pcluster/config/test_validators.py

@@ -227,59 +227,64 @@ def test_ec2_volume_validator(mocker, boto3_stubber):
 
 
 @pytest.mark.parametrize(
-    "region, base_os, scheduler, expected_message, expected_warning",
+    "region, base_os, scheduler, expected_message",
     [
         # verify awsbatch supported regions
-        ("ap-northeast-3", "alinux", "awsbatch", "scheduler is not supported in the .* region", None),
-        ("us-gov-east-1", "alinux", "awsbatch", "scheduler is not supported in the .* region", None),
-        ("us-gov-west-1", "alinux", "awsbatch", "scheduler is not supported in the .* region", None),
-        ("eu-west-1", "alinux", "awsbatch", None, None),
-        ("us-east-1", "alinux", "awsbatch", None, None),
-        ("eu-north-1", "alinux", "awsbatch", None, None),
-        ("cn-north-1", "alinux", "awsbatch", None, None),
-        ("cn-northwest-1", "alinux", "awsbatch", None, None),
-        ("cn-northwest-1", "alinux2", "awsbatch", None, None),
+        ("ap-northeast-3", "alinux", "awsbatch", "scheduler is not supported in the .* region"),
+        ("us-gov-east-1", "alinux", "awsbatch", "scheduler is not supported in the .* region"),
+        ("us-gov-west-1", "alinux", "awsbatch", "scheduler is not supported in the .* region"),
+        ("eu-west-1", "alinux", "awsbatch", None),
+        ("us-east-1", "alinux", "awsbatch", None),
+        ("eu-north-1", "alinux", "awsbatch", None),
+        ("cn-north-1", "alinux", "awsbatch", None),
+        ("cn-northwest-1", "alinux", "awsbatch", None),
+        ("cn-northwest-1", "alinux2", "awsbatch", None),
         # verify traditional schedulers are supported in all the regions
-        ("cn-northwest-1", "alinux", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("ap-northeast-3", "alinux", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("cn-northwest-1", "alinux", "slurm", None, None),
-        ("ap-northeast-3", "alinux", "slurm", None, None),
-        ("cn-northwest-1", "alinux", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("ap-northeast-3", "alinux", "torque", None, ".torque. is scheduled to be deprecated"),
+        ("cn-northwest-1", "alinux", "sge", None),
+        ("ap-northeast-3", "alinux", "sge", None),
+        ("cn-northwest-1", "alinux", "slurm", None),
+        ("ap-northeast-3", "alinux", "slurm", None),
+        ("cn-northwest-1", "alinux", "torque", None),
+        ("ap-northeast-3", "alinux", "torque", None),
         # verify awsbatch supported OSes
-        ("eu-west-1", "centos6", "awsbatch", "scheduler supports the following Operating Systems", None),
-        ("eu-west-1", "centos7", "awsbatch", "scheduler supports the following Operating Systems", None),
-        ("eu-west-1", "ubuntu1604", "awsbatch", "scheduler supports the following Operating Systems", None),
-        ("eu-west-1", "ubuntu1804", "awsbatch", "scheduler supports the following Operating Systems", None),
-        ("eu-west-1", "alinux", "awsbatch", None, None),
-        ("eu-west-1", "alinux2", "awsbatch", None, None),
+        ("eu-west-1", "centos6", "awsbatch", "scheduler supports the following Operating Systems"),
+        ("eu-west-1", "centos7", "awsbatch", "scheduler supports the following Operating Systems"),
+        ("eu-west-1", "ubuntu1604", "awsbatch", "scheduler supports the following Operating Systems"),
+        ("eu-west-1", "ubuntu1804", "awsbatch", "scheduler supports the following Operating Systems"),
+        ("eu-west-1", "alinux", "awsbatch", None),
+        ("eu-west-1", "alinux2", "awsbatch", None),
         # verify sge supports all the OSes
-        ("eu-west-1", "centos6", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("eu-west-1", "centos7", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("eu-west-1", "ubuntu1604", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("eu-west-1", "ubuntu1804", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("eu-west-1", "alinux", "sge", None, ".sge. is scheduled to be deprecated"),
-        ("eu-west-1", "alinux2", "sge", None, ".sge. is scheduled to be deprecated"),
+        ("eu-west-1", "centos6", "sge", None),
+        ("eu-west-1", "centos7", "sge", None),
+        ("eu-west-1", "ubuntu1604", "sge", None),
+        ("eu-west-1", "ubuntu1804", "sge", None),
+        ("eu-west-1", "alinux", "sge", None),
+        ("eu-west-1", "alinux2", "sge", None),
         # verify slurm supports all the OSes
-        ("eu-west-1", "centos6", "slurm", None, None),
-        ("eu-west-1", "centos7", "slurm", None, None),
-        ("eu-west-1", "ubuntu1604", "slurm", None, None),
-        ("eu-west-1", "ubuntu1804", "slurm", None, None),
-        ("eu-west-1", "alinux", "slurm", None, None),
-        ("eu-west-1", "alinux2", "slurm", None, None),
+        ("eu-west-1", "centos6", "slurm", None),
+        ("eu-west-1", "centos7", "slurm", None),
+        ("eu-west-1", "ubuntu1604", "slurm", None),
+        ("eu-west-1", "ubuntu1804", "slurm", None),
+        ("eu-west-1", "alinux", "slurm", None),
+        ("eu-west-1", "alinux2", "slurm", None),
         # verify torque supports all the OSes
-        ("eu-west-1", "centos6", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("eu-west-1", "centos7", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("eu-west-1", "ubuntu1604", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("eu-west-1", "ubuntu1804", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("eu-west-1", "alinux", "torque", None, ".torque. is scheduled to be deprecated"),
-        ("eu-west-1", "alinux2", "torque", None, ".torque. is scheduled to be deprecated"),
+        ("eu-west-1", "centos6", "torque", None),
+        ("eu-west-1", "centos7", "torque", None),
+        ("eu-west-1", "ubuntu1604", "torque", None),
+        ("eu-west-1", "ubuntu1804", "torque", None),
+        ("eu-west-1", "alinux", "torque", None),
+        ("eu-west-1", "alinux2", "torque", None),
     ],
 )
-def test_scheduler_validator(mocker, capsys, region, base_os, scheduler, expected_message, expected_warning):
+def test_scheduler_validator(mocker, capsys, region, base_os, scheduler, expected_message):
     # we need to set the region in the environment because it takes precedence respect of the config file
     os.environ["AWS_DEFAULT_REGION"] = region
     config_parser_dict = {"cluster default": {"base_os": base_os, "scheduler": scheduler}}
+    # Deprecation warning should be printed for sge and torque
+    expected_warning = None
+    wiki_url = "https://github.com/aws/aws-parallelcluster/wiki/Deprecation-of-SGE-and-Torque-in-ParallelCluster"
+    if scheduler in ["sge", "torque"]:
+        expected_warning = ".{0}. is scheduled to be deprecated.*{1}".format(scheduler, wiki_url)
     utils.assert_param_validator(mocker, config_parser_dict, expected_message, capsys, expected_warning)