-
Notifications
You must be signed in to change notification settings - Fork 11
/
10_DevOps.html
254 lines (247 loc) · 11.8 KB
/
10_DevOps.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DevOps | D365-UI-Test</title>
<meta name="description" content="Documentation for D365-UI-Test">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../assets/css/main.css">
<link rel="stylesheet" href="../../assets/css/pages.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../../assets/js/search.json" data-base="../..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../../index.html" class="title">D365-UI-Test</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../../globals.html">Globals</a>
</li>
<li>
<a href="01_Startup.html">Tutorials</a>
</li>
<li>
<a href="10_DevOps.html">DevOps</a>
</li>
</ul>
<h1>DevOps</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#devops" id="devops" style="color: inherit; text-decoration: none;">
<h1>DevOps</h1>
</a>
<p>Once you have a working set of UI tests, you should run them automatically using an automated build such as DevOps.</p>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<p>Easiest way possible is to just create a new build pipeline with the nodejs template.
Afterwards you can just insert below yaml for a build which runs your tests all 2 hours, publishes reports and publishes test results.
You then need to create the 4 pipeline variables crmUrl, userName, userPassword and mfaSecret (at least userPassword and if used mfaSecret should be stored as secret value).
You have to set mfaSecret to an empty value even if you don't have a mfaSecret.</p>
<pre><code class="language-yaml"><span class="hljs-comment"># Node.js</span>
<span class="hljs-comment"># Build a general Node.js project with npm.</span>
<span class="hljs-comment"># Add steps that analyze code, save build artifacts, deploy, and more:</span>
<span class="hljs-comment"># https://docs.microsoft.com/azure/devops/pipelines/languages/javascript</span>
<span class="hljs-attr">trigger:</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">master</span>
<span class="hljs-attr">schedules:</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">cron:</span> <span class="hljs-string">"0 */2 * * *"</span>
<span class="hljs-attr">displayName:</span> <span class="hljs-string">Every</span> <span class="hljs-string">two</span> <span class="hljs-string">hours</span>
<span class="hljs-attr">branches:</span>
<span class="hljs-attr">include:</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">master</span>
<span class="hljs-attr">always:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">pool:</span>
<span class="hljs-attr">vmImage:</span> <span class="hljs-string">'ubuntu-22.04'</span>
<span class="hljs-attr">steps:</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">task:</span> <span class="hljs-string">NodeTool@0</span>
<span class="hljs-attr">inputs:</span>
<span class="hljs-attr">versionSpec:</span> <span class="hljs-string">'18.x'</span>
<span class="hljs-attr">displayName:</span> <span class="hljs-string">'Install Node.js'</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">script:</span> <span class="hljs-string">|
npm ci
npx playwright install-deps
npm run test
</span> <span class="hljs-attr">displayName:</span> <span class="hljs-string">'npm install and build'</span>
<span class="hljs-attr">env:</span>
<span class="hljs-attr">D365_UI_TEST_URL:</span> <span class="hljs-string">$(crmUrl)</span>
<span class="hljs-attr">D365_UI_TEST_USERNAME:</span> <span class="hljs-string">$(userName)</span>
<span class="hljs-attr">D365_UI_TEST_PASSWORD:</span> <span class="hljs-string">$(userPassword)</span>
<span class="hljs-attr">D365_UI_TEST_MFA_SECRET:</span> <span class="hljs-string">$(mfaSecret)</span>
<span class="hljs-attr">D365_UI_TEST_HEADLESS:</span> <span class="hljs-literal">true</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">task:</span> <span class="hljs-string">PublishBuildArtifacts@1</span>
<span class="hljs-attr">inputs:</span>
<span class="hljs-attr">PathtoPublish:</span> <span class="hljs-string">'./reports/'</span>
<span class="hljs-attr">ArtifactName:</span> <span class="hljs-string">'Reports'</span>
<span class="hljs-attr">publishLocation:</span> <span class="hljs-string">'Container'</span>
<span class="hljs-attr">condition:</span> <span class="hljs-string">always()</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">task:</span> <span class="hljs-string">PublishTestResults@2</span>
<span class="hljs-attr">inputs:</span>
<span class="hljs-attr">testResultsFormat:</span> <span class="hljs-string">'JUnit'</span>
<span class="hljs-attr">testResultsFiles:</span> <span class="hljs-string">'**/junit_*.xml'</span>
<span class="hljs-attr">failTaskOnFailedTests:</span> <span class="hljs-literal">false</span>
<span class="hljs-attr">condition:</span> <span class="hljs-string">always()</span>
</code></pre>
<a href="#storing-credentials" id="storing-credentials" style="color: inherit; text-decoration: none;">
<h2>Storing credentials</h2>
</a>
<p><strong>You should absolutely not check in your login data into your repository.</strong></p>
<p>D365-UI-Test advices to store your url, user name and password as dev ops variables. You can easily define them in the yaml editor by clicking the "Variables" button. <strong>Make sure to save at least the user password as secret variable in DevOps</strong>.
The above yaml already takes care of setting environment variables for the D365-UI-Test execution.
You can see that it takes the pipeline variables 'crmUrl', 'userName' and 'userPassword' and assigns them to the variables CRM_URL, USER_NAME and USER_PASSWORD.
These will be able to be accessed in D365-UI-Test like this:</p>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> page = <span class="hljs-keyword">await</span> xrmTest.open(process.env.CRM_URL, { <span class="hljs-attr">userName</span>: process.env.USER_NAME, <span class="hljs-attr">password</span>: process.env.USER_PASSWORD });
</code></pre>
<a href="#remarks" id="remarks" style="color: inherit; text-decoration: none;">
<h2>Remarks</h2>
</a>
<p>When running in DevOps, be sure to use the headless runner as described in 01_Startup:</p>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> browser = <span class="hljs-keyword">await</span> xrmTest.launch({
<span class="hljs-attr">headless</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">args</span>: [
<span class="hljs-string">"--start-fullscreen"</span>
]
});
</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label pp-nav pp-group">
<span>Tutorials</span>
</li>
<li class=" pp-nav pp-page">
<a href="01_Startup.html">Startup</a>
</li>
<li class=" pp-nav pp-page">
<a href="02_Navigation.html">Navigation</a>
</li>
<li class=" pp-nav pp-page">
<a href="03_Attributes.html">Attributes</a>
</li>
<li class=" pp-nav pp-page">
<a href="04_Controls.html">Controls</a>
</li>
<li class=" pp-nav pp-page">
<a href="05_Buttons.html">Buttons</a>
</li>
<li class=" pp-nav pp-page">
<a href="06_Subgrids.html">Subgrids</a>
</li>
<li class=" pp-nav pp-page">
<a href="07_Tabs.html">Tabs</a>
</li>
<li class=" pp-nav pp-page">
<a href="14_Sections.html">Sections</a>
</li>
<li class=" pp-nav pp-page">
<a href="08_Entity.html">Entity</a>
</li>
<li class=" pp-nav pp-page">
<a href="09_Dialogs.html">Dialogs</a>
</li>
<li class="current pp-nav pp-page">
<a href="10_DevOps.html">Dev<wbr>Ops</a>
</li>
<li class=" pp-nav pp-page">
<a href="11_FAQs.html">FAQs</a>
</li>
<li class=" pp-nav pp-page">
<a href="12_TestUtils.html">Test<wbr>Utils</a>
</li>
<li class=" pp-nav pp-page">
<a href="13_Troubleshooting.html">Troubleshooting</a>
</li>
<li class="label pp-nav pp-group">
<span>API</span>
</li>
<li class="globals ">
<a href="../../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-namespace">
<a href="../../modules/testutils.html">Test<wbr>Utils</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../../modules/__global.html">__global</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../../assets/js/search.json"><' + '/script>');</script>
</body>
</html>