From 3d7f621ea795f8eba7c37e4720bb4eb3e82d11b7 Mon Sep 17 00:00:00 2001
From: "nia.mccash" <nia.mccash@utoronto.ca>
Date: Fri, 30 Sep 2022 11:06:47 -0700
Subject: [PATCH 1/3] Added linter check for 'Provide alternate value when
 fetching Glide property'

---
 ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt |  2 +-
 ...check_4986078c2f6330d05dcb59ab2799b6d9.xml | 76 +++++++++++++++++++
 2 files changed, 77 insertions(+), 1 deletion(-)
 create mode 100644 ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml

diff --git a/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt b/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
index 3620891..d533f22 100644
--- a/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
+++ b/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
@@ -1 +1 @@
-aQgfvSnhfC1wVpuKQWhyhUbVCWpldAIXeFWQKJua_aMBJoo85rtlMi5xn9KG5nidXKThCkM8feBrcyFJeo-VtULwIXM7nd5AhwRgHc-VCp5tkNM4hsqpmD28YvfJ-rPIJYR_mUqcUwW_ID_GEKPARpUmsJXWMf-jmcc-ObkNNXJvYdzC2bWesQhNmYZP8gmjejTCkz-ID2_yOqqtcrxakfHtzadbAlixtE6-Ips8WZJwkFKogWjfXbeRFkkt2Q38ElCebT3gI8d3EFmdRZLHW20jpzYWgOR4HbGWM4zWyWoOlfcPGgYwheLugrwtDHodWMf6VDAvnmLqHCORandvFfF8o2Ci794mag0lIWxXsQ3Jzl5gZMb4Hu2I9wFSw0sJzwfYUnD1DB-gLlKaRN-0rWcW2b8ik8yt26GVcMXoqUdX514AFoPk4RO-Q-QpoEaBJ5RskOvepYP62AZ8zMb3wDqJUTJRfy3_uQQXMOmIHTI8HSVUL54ddI2uRrfEtvBlYldjHECjFOu716btBVX9WW828DhvbDtGE2VA4cKz4O4LRWQenhRdbhdWcPKAcAYSMLyliNLMkABTEd6OfpJD_GPA5AGlgb12DZtneAqIUEFFzpuS1fQMZLOd8ceXGo4o1bk-W6fH8PiNGkK2Xtyb93W2UXBvDNRxKlNWVeaIEVY
\ No newline at end of file
+smaaC0ut_WJEzMVwWzgYqI6NnnWCPsqxD9nq9TAQCvimEsYORch6vjpxXxzEI3MPnjtAdGROtFGjc4G6v32Z-WvnwOclWEtvAZIjyXPUBLfUf8KNI-hlY00E4nxPHHIBRT4tlajCmQJ0MSdlnTCSwXPSkrbPBXPzfIzFoTp6TStjflng-xGFHdbdZl2lC2IymbHYaVWSmz39652o3w_QHJKsDk01JhIpN5VKDf-_hpfNeK_B1GTdH6hfwfePUGHfVTwtpB1sU-1zf75esqaffcSK1mYQ2orFzDGRV9KjKBME1aJ9JX5ZEJTijYC7wMAqiQTsRE70_IFVYlioQ63yKf5Y5kJxhb1OQ3UGRvKlrP7NPCpMEv8iq9w8rH5PoZJMW7W2wFzjz6MD26ug3fqTWGwbTgTgBtojryiKE_W56LmwvutjrJ4mkj9Zoaso8jHc_QhuSS0Cbl3_ZxQbekMRHi62a998Ui9i_1wUqLj-CChWwhKJjiWQeGjMu7NjUQSy11aSbudseOLZROoTkUCNt5IS4a6SmOXoiMX1x6fUw0stoLo0Y7S_hKdJPGAE3BEsfh72IjIRLE0AAhjL8e8pwgMYEePyrMF1XzOAndPPcwIdQLBUpSe-jkYmHLCG573YXhcMWffS8kaablvpt1DUrtVhLXrsnEcCaQt4XISIn6k
\ No newline at end of file
diff --git a/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml b/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml
new file mode 100644
index 0000000..19c576b
--- /dev/null
+++ b/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?><record_update table="scan_linter_check">
+    <scan_linter_check action="INSERT_OR_UPDATE">
+        <active>true</active>
+        <attributes/>
+        <category>user_experience</category>
+        <description>Providing an alternate, default value when calling gs.getProperty() helps mitigate risk of errors when property does not exist.</description>
+        <documentation_url/>
+        <finding_type>scan_finding</finding_type>
+        <name>Provide alternate value when fetching Glide property</name>
+        <priority>3</priority>
+        <resolution_details>Consider providing an alternate. default  value when using gs.getProperty() in case the property does not exist</resolution_details>
+        <run_condition/>
+        <score_max>100</score_max>
+        <score_min>0</score_min>
+        <score_scale>1</score_scale>
+        <script><![CDATA[(function (engine) {
+
+	/** 
+	  * The following to exclude certain tables like sys_script_execution_history 
+	  * from being part of this scan is NOT possible here due to app scoping issues
+	  * (https://github.com/ServiceNowDevProgram/example-instancescan-checks/issues/9)
+	  */
+	//var excludedTablesProp = gs.getProperty(/* custom property name here */);
+	//var excludedTables = excludedTablesProp.split(',');
+	//var tableName = engine.current.getTableName();
+	//if (!new ArrayUtil().contains(excludedTables, tableName)) {
+	
+    engine.rootNode.visit(function(node) {
+		
+		// Find an occurrence of the getProperty function
+		if (node.getNameIdentifier() && node.getNameIdentifier() === 'getProperty') {
+
+			// Walk up the AST tree to check if function is called on GlideSystem 
+			if (node.getParent().getTypeName() === 'GETPROP' 
+				&& node.getParent().toSource() === 'gs.getProperty') {
+				
+				var argsProvided = 0;
+				
+				// Walk up to grandparent to check for the arguments provided
+				node.getParent().getParent().visit(function(childnode) {
+					// Case 1: Finds argument specified as a string, including when 
+					// default value is provided as number or boolean
+					// eg. gs.getProperty('value1', 'value2');
+					if (childnode.getTypeName() === 'STRING' || childnode.getTypeName() === 'NUMBER' 
+						|| childnode.getTypeName() === 'TRUE' || childnode.getTypeName() === 'FALSE') {
+						argsProvided ++;
+					}
+					// Case 2: Find argument specified as a variable
+					// eg. gs.getProperty(propertyName, defaultValue);
+					else if (childnode.getTypeName() === 'NAME' && childnode.getNameIdentifier()
+						&& childnode.getNameIdentifier() !== 'gs' 
+						&& childnode.getNameIdentifier() !== 'getProperty') {
+						argsProvided++;
+					}
+
+				});
+				if (argsProvided != 2) {
+					engine.finding.incrementWithNode(node);
+				}
+			}				
+		}
+	});
+
+})(engine);]]></script>
+        <short_description>Provide alternate value when fetching Glide property</short_description>
+        <sys_class_name>scan_linter_check</sys_class_name>
+        <sys_created_by>nia.mccash</sys_created_by>
+        <sys_created_on>2021-10-27 13:39:00</sys_created_on>
+        <sys_id>4986078c2f6330d05dcb59ab2799b6d9</sys_id>
+        <sys_name>Provide alternate value when fetching Glide property</sys_name>
+        <sys_package display_value="Example Instance Checks" source="x_appe_exa_checks">ca8467c41b9abc10ce0f62c3b24bcbaa</sys_package>
+        <sys_policy/>
+        <sys_scope display_value="Example Instance Checks">ca8467c41b9abc10ce0f62c3b24bcbaa</sys_scope>
+        <sys_update_name>scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9</sys_update_name>
+    </scan_linter_check>
+</record_update>

From cec8a2949eff723f92b30798ec0fcfbe7f01e021 Mon Sep 17 00:00:00 2001
From: "nia.mccash" <nia.mccash@utoronto.ca>
Date: Fri, 30 Sep 2022 11:08:13 -0700
Subject: [PATCH 2/3] Updated category for new linter check added for 'Provide
 alternate value when fetching Glide property'

---
 ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt                   | 2 +-
 .../scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt b/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
index d533f22..1f8b727 100644
--- a/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
+++ b/ca8467c41b9abc10ce0f62c3b24bcbaa/checksum.txt
@@ -1 +1 @@
-smaaC0ut_WJEzMVwWzgYqI6NnnWCPsqxD9nq9TAQCvimEsYORch6vjpxXxzEI3MPnjtAdGROtFGjc4G6v32Z-WvnwOclWEtvAZIjyXPUBLfUf8KNI-hlY00E4nxPHHIBRT4tlajCmQJ0MSdlnTCSwXPSkrbPBXPzfIzFoTp6TStjflng-xGFHdbdZl2lC2IymbHYaVWSmz39652o3w_QHJKsDk01JhIpN5VKDf-_hpfNeK_B1GTdH6hfwfePUGHfVTwtpB1sU-1zf75esqaffcSK1mYQ2orFzDGRV9KjKBME1aJ9JX5ZEJTijYC7wMAqiQTsRE70_IFVYlioQ63yKf5Y5kJxhb1OQ3UGRvKlrP7NPCpMEv8iq9w8rH5PoZJMW7W2wFzjz6MD26ug3fqTWGwbTgTgBtojryiKE_W56LmwvutjrJ4mkj9Zoaso8jHc_QhuSS0Cbl3_ZxQbekMRHi62a998Ui9i_1wUqLj-CChWwhKJjiWQeGjMu7NjUQSy11aSbudseOLZROoTkUCNt5IS4a6SmOXoiMX1x6fUw0stoLo0Y7S_hKdJPGAE3BEsfh72IjIRLE0AAhjL8e8pwgMYEePyrMF1XzOAndPPcwIdQLBUpSe-jkYmHLCG573YXhcMWffS8kaablvpt1DUrtVhLXrsnEcCaQt4XISIn6k
\ No newline at end of file
+ZCv9qMuUECPrTGsjutWyjVM6cefm_yWSCqBvdU5jOa9uSn7hiI95_m0V8_jlfMEU2FiFlapN-Ss6Q_K-REFvJw12mEIr5QB3H8K0mrWENPYVncsHXtvXlfBikpUcSt21sf_7WU5JFeDIzLXNmeLSiQFFVVcvbTX50yMmURQ9pr9IZJUeKj9a-gbJqYsQxZg0BggN9TxjY3gZzjmLc6mH7aPl_QarAd_mhvzNTODSrAKl3C3SPzdJiPggT_KyR4ZzjwbOpUnQj05jprKUXFkJ9JqbaIHyPHZW7IUuy0vHZa4Qu1_Yv1DS16MfyqYSZZJSXHTOQv1dL6BtpZnhVAm5DJ5QLNrkcALIX9lG6Ij3nL_W8CF9utf39dUlmrQcD43S03VUaB9931k44KoSylO60i3UIxSs_-hqaI1nrtKOogaTtN47-Gw66GqS_OmduFl5gZsNAkjZcf2Cp8IdBgia4wUzThFjDVIBvyDsdmCJs6egUXHw9OMf1YCdp4WS-819ePV4gAJzFs0yoM6uYMhLocgkVBVQI0VeNxIWcm-9ztoLxZ4n2V6vqg9f-Q7UKVLSdbPOBbwXhzU7J50BsMwE8mZ5GhzJ1wnbavlZs_oyyhyZZOJHO1mSLNLpHzvC58AE87ur5OZCoc3tUlkl38lZSChiTMa_Ds9RajkJT5A0uyE
\ No newline at end of file
diff --git a/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml b/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml
index 19c576b..87d3b0b 100644
--- a/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml
+++ b/ca8467c41b9abc10ce0f62c3b24bcbaa/update/scan_linter_check_4986078c2f6330d05dcb59ab2799b6d9.xml
@@ -2,7 +2,7 @@
     <scan_linter_check action="INSERT_OR_UPDATE">
         <active>true</active>
         <attributes/>
-        <category>user_experience</category>
+        <category>performance</category>
         <description>Providing an alternate, default value when calling gs.getProperty() helps mitigate risk of errors when property does not exist.</description>
         <documentation_url/>
         <finding_type>scan_finding</finding_type>

From d7232dd47ea06b7c62df473ccfef05a1338cac1d Mon Sep 17 00:00:00 2001
From: niamccash <39105458+niamccash@users.noreply.github.com>
Date: Fri, 30 Sep 2022 14:10:52 -0400
Subject: [PATCH 3/3] Updated with info for new gs.getProperty Linter check

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index b311a7a..be11581 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,10 @@ api.controller = function ($rootScope, $scope) {
 };
 ```
 
+### Provide alternate value when fetching Glide property
+Recommendation to provide alternate/default value when calling gs.getProperty() to avoid errors if the property is not set. 
+
+
 ## Category: Security
 
 ### Tables without ACLs