MQE-352: Review and Update SampleCest.xml for added functionality

Author: tomreece

dev/tests/acceptance/tests/functional/Magento/FunctionalTest/SampleTests/Cest/SampleCest.xml

@@ -254,17 +254,34 @@
                 <severity value="CRITICAL"/>
                 <testCaseId value="#"/>
             </annotations>
+
             <createData entity="CustomerEntity1" mergeKey="testScopeData"/>
+
+            <!-- parameterized url that uses literal params -->
             <amOnPage url="{{SamplePage.url('success','success2')}}" mergeKey="a0"/>
-            <amOnPage url="/$testScopeData.firstname$.html" mergeKey="a1"/>
-            <amOnPage url="/$$createData1.firstname$$.html" mergeKey="a2"/>
+
+            <!-- url referencing data that was created in this <test> -->
+            <amOnPage url="$testScopeData.firstname$.html" mergeKey="a1"/>
+
+            <!-- url referencing data that was created in a <before> -->
+            <amOnPage url="$$createData1.firstname$$.html" mergeKey="a2"/>
+
+            <!-- parameterized url that uses created data params -->
             <amOnPage url="{{SamplePage.url($testScopeData.firstname$,$testScopeData.lastname$)}}" mergeKey="a3"/>
             <amOnPage url="{{SamplePage.url($$createData1.firstname$$,$$createData1.lastname$$)}}" mergeKey="a4"/>
+
+            <!-- parameterized selector that uses literal params -->
             <click selector="{{SampleSection.oneParamElement('success')}}" mergeKey="c1"/>
             <click selector="{{SampleSection.twoParamElement('success','success2')}}" mergeKey="c2"/>
+
+            <!-- parameterized selector with literal, static data, and created data  -->
             <click selector="{{SampleSection.threeParamElement('John', SamplePerson.lastname, $testScopeData.lastname$)}}" mergeKey="c3"/>
+
+            <!-- selector that uses created data -->
             <click selector="#$testScopeData.firstname$ .$testScopeData.lastname$" mergeKey="c4"/>
             <click selector="#$$createData1.firstname$$ .$$createData1.lastname$$" mergeKey="c5"/>
+
+            <!-- userInput that uses created data -->
             <fillField selector="#sample" userInput="Hello $testScopeData.firstname$ $testScopeData.lastname$" mergeKey="f1"/>
             <fillField selector="#sample" userInput="Hello $$createData1.firstname$$ $$createData1.lastname$$" mergeKey="f2"/>
         </test>