-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmapscript.html
More file actions
281 lines (238 loc) · 15.4 KB
/
mapscript.html
File metadata and controls
281 lines (238 loc) · 15.4 KB
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MapScript Unit Testing — MapServer 8.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx.css?v=48f05237" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=dd298242" />
<link rel="stylesheet" type="text/css" href="../../_static/ribbon.css?v=ea091bf4" />
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=ad95d4c4"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=f281be69"></script>
<link rel="icon" href="../../_static/mapserver.ico"/>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="copyright" title="Copyright" href="../../copyright.html" />
<link rel="next" title="Mapfile Editing" href="../editing/index.html" />
<link rel="prev" title="Regression Testing (msautotest)" href="autotest.html" />
</head><body>
<!-- for main branch only, do not backport this -->
<table width="100%" style="width: 100%; background-color: white;">
<tr>
<td rowspan="2" style="padding: 10px 0px 10px 10px;">
<a href="../../index.html" title="Home"><img src="../../_static/banner.png" alt="MapServer banner" border="0" /></a>
</td>
<td style="padding: 10px 10px 0px 0px; text-align: right; vertical-align: top;">
<a href="../../index.html" title="Home">Home</a> |
<a href="../../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |
<a href="https://github.com/mapserver/mapserver/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |
<a href="../../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |
<a href="../../faq.html" title="Frequently Asked Questions">FAQ</a> |
<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |
<a href="../../download.html" title="Download Source or Binaries">Download </a> |
<a class="badge" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KRJ2X44N3HA6U&source=url" target="_blank">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate to MapServer">
</a>
</td>
</tr>
<tr>
<td style="padding: 0px 10px 0px 0px; text-align: right; vertical-align: bottom;">
<img src="../../_static/flagicons/en.png" alt="en" title="en" border="0" width="18px" height="13px"/>
<a href="../../ar/development/tests/mapscript.html"><img src="../../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../../de/development/tests/mapscript.html"><img src="../../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../../el/development/tests/mapscript.html"><img src="../../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../../es/development/tests/mapscript.html"><img src="../../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../../fr/development/tests/mapscript.html"><img src="../../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../../id/development/tests/mapscript.html"><img src="../../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../../it/development/tests/mapscript.html"><img src="../../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<a href="../../ja/development/tests/mapscript.html"><img src="../../_static/flagicons/ja.png" alt="ja" title="ja" border="0" /></a>
<a href="../../nl_NL/development/tests/mapscript.html"><img src="../../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../../pl/development/tests/mapscript.html"><img src="../../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../../ru/development/tests/mapscript.html"><img src="../../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../../sq/development/tests/mapscript.html"><img src="../../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../../tr/development/tests/mapscript.html"><img src="../../_static/flagicons/tr.png" alt="tr" title="tr" border="0" /></a>
</td>
</tr>
</table>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../editing/index.html" title="Mapfile Editing"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="autotest.html" title="Regression Testing (msautotest)"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Development</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Testing</a> »</li>
<li class="nav-item nav-item-this"><a href="">MapScript Unit Testing</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="mapscript-unit-testing">
<span id="mapscript-tests"></span><h1>MapScript Unit Testing<a class="headerlink" href="#mapscript-unit-testing" title="Link to this heading">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Date<span class="colon">:</span></dt>
<dd class="field-odd"><p>2005-11-20</p>
</dd>
<dt class="field-even">Author<span class="colon">:</span></dt>
<dd class="field-even"><p>Sean Gillies</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <a class="reference internal" href="autotest.html#autotest"><span class="std std-ref">msautotest</span></a> infrastructure is recommended, as it is
run for each commit/pull request to the MapServer repository.</p>
</div>
<section id="test-driven-development">
<h2>Test Driven Development<a class="headerlink" href="#test-driven-development" title="Link to this heading">¶</a></h2>
<p>In 2003, I began to commit to test driven development of the mapscript module.
TDD simply means development through repetition of two activities:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>add a test, cause failure, and write code to pass the test</p></li>
<li><p>remove duplication</p></li>
</ol>
</div></blockquote>
<p>Test Driven Development is also a book by Kent Beck.</p>
<p>New features that I develop for MapServer begin as test expressions. There are
a bazillion good reasons for working this way. The most obvious are</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>accumulation of automated unit tests</p></li>
<li><p>accumulation of excellent usage examples</p></li>
<li><p>that i’m prevented from starting work on flaky ideas that can’t be tested</p></li>
</ol>
</div></blockquote>
</section>
<section id="about-the-tests">
<h2>About the tests<a class="headerlink" href="#about-the-tests" title="Link to this heading">¶</a></h2>
<p>Tests are committed to the MapServer CVS under mapscript/python/tests. They
are written in Python using the JUnit inspired unittest module. A good
introduction to unit testing with Python is found at
<a class="reference external" href="https://diveintopython3.net/unit-testing.html">https://diveintopython3.net/unit-testing.html</a>.</p>
<p>The test framework imports mapscript from python/tests/cases/testing.py. This
allows us to test the module before installation</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[sean@lenny python]$ python setup.py build
[sean@lenny python]$ python tests/runtests.py -v
</pre></div>
</div>
<p>Test cases are implemented as Python classes, and individual tests as class
methods named beginning with test*. The special setUp() and tearDown() methods
are for test fixtures and are called before and after every individual test.</p>
<p>Since version 4.2, MapServer includes a very lightweight testing dataset under
mapserver/tests. The set consists of symbols, fonts, three single-feature
shapefiles, and a test.map mapfile. This is the only data used by the unit
tests.</p>
<p>Many tests that require a mapObj derive from testing.MapTestCase:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">MapTestCase</span><span class="p">(</span><span class="n">MapPrimitivesTestCase</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Base class for testing with a map fixture"""</span>
<span class="k">def</span><span class="w"> </span><span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="n">mapscript</span><span class="o">.</span><span class="n">mapObj</span><span class="p">(</span><span class="n">TESTMAPFILE</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">tearDown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<p>One example is the MapSymbolSetTestCase, the test case I used for development
of the expanded symbolset functionality present in the 4.2 release:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">MapSymbolSetTestCase</span><span class="p">(</span><span class="n">MapTestCase</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">testGetNumSymbols</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""expect getNumSymbols == 2 from test fixture test.map"""</span>
<span class="n">num</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">getNumSymbols</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">num</span> <span class="o">==</span> <span class="mi">2</span><span class="p">,</span> <span class="n">num</span>
<span class="o">...</span>
</pre></div>
</div>
</section>
<section id="status">
<h2>Status<a class="headerlink" href="#status" title="Link to this heading">¶</a></h2>
<p>This unit testing framework only covers functionality that is exposed
to the Python mapscript module. It can help to check on pieces of the
core MapServer code, but is no guarantor of the <a class="reference internal" href="../../cgi/mapserv.html#mapserv"><span class="std std-ref">mapserv</span></a> program
or of the <a class="reference internal" href="../../mapscript/php/index.html#php-mapscript"><span class="std std-ref">PHP MapScript</span></a> module. As of this
writing, there are 159 tests in the suite. These are tests of
features added since mid-2003. Much of MapServer’s older stuff remains
untested and it is doubtful that we’ll make the time to go back and
fill in.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p>
<a href="../../about.html" title="About">About</a><br>
<a href="../../products.html" title="Products">Products</a><br>
<a href="../../community/index.html" title="Community">Community</a><br>
<a href="../index.html" title="Development">Development</a><br>
<a href="../../download.html" title="Downloads">Downloads</a><br>
<a href="../../documentation.html" title="Documentation">Documentation</a><br>
<a href="../../faq.html" title="FAQ">FAQ</a><br>
<a href="../../psc.html" title="PSC">PSC</a><br>
<a href="https://fosstodon.org/@mapserver" title="Mastodon">Mastodon</a>
</p>
<h3>Current Table Of Contents</h3>
<ul>
<li><a class="reference internal" href="#">MapScript Unit Testing</a><ul>
<li><a class="reference internal" href="#test-driven-development">Test Driven Development</a></li>
<li><a class="reference internal" href="#about-the-tests">About the tests</a></li>
<li><a class="reference internal" href="#status">Status</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../editing/index.html" title="Mapfile Editing"
>next</a> |</li>
<li class="right" >
<a href="autotest.html" title="Regression Testing (msautotest)"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Development</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >Testing</a> »</li>
<li class="nav-item nav-item-this"><a href="">MapScript Unit Testing</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
Last updated on 2026-03-29.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
</html>