Merge pull request #102 from CiscoDevNet/vb-edits

Update verify.py

Author: agentlecisco

verify/backend/spark.py

@@ -1,11 +1,12 @@
 #!/usr/bin/env python
-"""Verify the Cisco Spark APIs are accessible and responding.
+"""Verify the Cisco Webex APIs are accessible and responding.
 
 Verify that user's provide SPARK_ACCESS_TOKEN is valid and that calls to the
-Cisco Spark APIs complete successfully.
+Cisco Webex (formerly Spark) APIs complete successfully. Uses SPARK_
+for variable names; the product name is Cisco Webex.
 
 
-Copyright (c) 2018 Cisco and/or its affiliates.
+Copyright (c) 2018-21 Cisco and/or its affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -48,10 +49,10 @@
 
 
 def verify() -> bool:
-    """Verify access to the Cisco Spark APIs."""
-    print("==> Verifying access to the Cisco Spark APIs")
+    """Verify access to the Cisco Webex APIs."""
+    print("==> Verifying access to the Cisco Webex APIs")
 
-    # Check to ensure the user has provided their Spark Access Token
+    # Check to ensure the user has provided their Webex Access Token
     if not env_user.SPARK_ACCESS_TOKEN:
         print(
             "\nFAILED: You must provide your SPARK_ACCESS_TOKEN in the "
@@ -63,35 +64,35 @@ def verify() -> bool:
         access_token=env_user.SPARK_ACCESS_TOKEN
     )
 
-    # Verify the Cisco Spark APIs are accessible and responding
+    # Verify the Cisco Webex APIs are accessible and responding
     try:
         me = spark.people.me()
     except ciscosparkapi.SparkApiError as e:
         print(
-            "\nFAILED: The API call to Cisco Spark returned the following "
+            "\nFAILED: The API call to Cisco Webex returned the following "
             "error:\n{}\n".format(e)
         )
         return False
 
     else:
         print(
-            "\nYou are connected to Cisco Spark as: {}\n".format(me.emails[0])
+            "\nYou are connected to Cisco Webex (formerly Cisco Spark) as: {}\n".format(me.emails[0])
         )
 
-    # Check to ensure the user has provided a Spark Room ID
+    # Check to ensure the user has provided a Webex Room ID
     if not env_user.SPARK_ROOM_ID:
         print(
             "\nFAILED: You must provide the SPARK_ROOM_ID of the room you "
             "want to work with in the env_user.py file.\n"
         )
         return False
 
-    # Verify the Spark Room exists and is accessible via the access token
+    # Verify the Webex Room exists and is accessible via the access token
     try:
         room = spark.rooms.get(env_user.SPARK_ROOM_ID)
     except ciscosparkapi.SparkApiError as e:
         print(
-            "\nFAILED: There was an error accessing the Spark Room using the "
+            "\nFAILED: There was an error accessing the Webex Room using the "
             "SPARK_ROOM_ID you provided; error details:\n{}\n".format(e)
         )
         return False

verify/verify.py

@@ -6,7 +6,7 @@
 environments are accessible and responding to API calls.
 
 
-Copyright (c) 2018 Cisco and/or its affiliates.
+Copyright (c) 2018-21 Cisco and/or its affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -71,20 +71,45 @@
     sys.exit(1)
 
 
+fail_bit = 0
+
+
+if env_lab.ENVIRONMENT_IN_USE == "sandbox" or env_lab.ENVIRONMENT_IN_USE == "express" or env_lab.ENVIRONMENT_IN_USE =="custom":
+    print(f"env_lab.py - ENVIRONMENT_IN_USE: {env_lab.ENVIRONMENT_IN_USE}")
+else:
+    print("\nImproper value inputted. go to env_lab.py and select either sandbox, express, or custom.")
+    print(f"ERROR: env_lab.py - Invalid ENVIRONMENT_IN_USE: {env_lab.ENVIRONMENT_IN_USE}")
+    fail_bit = 1
+
+print(f"env_user.py - SPARK_ACCESS_TOKEN: {env_user.SPARK_ACCESS_TOKEN}")
+print(f"env_user.py - SPARK_ROOM_ID: {env_user.SPARK_ROOM_ID}")
+print(f"env_user.py - MERAKI_API_KEY: {env_user.MERAKI_API_KEY}\n")
+
 # Verify backend lab environments
 backend = os.path.abspath(os.path.join(here, "backend"))
 verified = []
 for python_file in glob(os.path.join(backend, "*.py")):
     name = os.path.splitext(os.path.basename(python_file))[0]
     spec = spec_from_file_location(name, python_file)
     module = module_from_spec(spec)
-    spec.loader.exec_module(module)
-    verified.append(module.verify())
-
-if all(verified):
-    print("\nAll lab backend systems are responding.  You're good to go!")
+    try:
+        spec.loader.exec_module(module)
+        verified.append(module.verify())
+    except ModuleNotFoundError:
+        print("\nFAILED: Error importing module. You need to install lab requirements.  \n\tEnter Command: pip install -r requirements.txt")
+        fail_bit = 1
+        break
+    except AttributeError:
+        print("\nFAILED: Error due to invalid ENVIRONMENT_IN_USE input in the env_lab.py file. \n\tCheck to see if the environment requires VPN access.")
+        fail_bit = 1
+        break
+
+if fail_bit == 1:
+    print("\nCorrect Errors and rerun.\n")
+elif all(verified):
+    print("\nAll lab backend systems are responding.  You're good to go!\n")
 else:
     print(
         "\nSome of the backend systems didn't respond or reported errors; "
-        "please check the above output for details."
+        "please check the above output for details.\n"
     )