Clarify docstrings for pkg java ver unit tests
[integration/packaging.git] / packages / test_lib.py
1 ##############################################################################
2 # Copyright (c) 2016 Daniel Farrell.  All rights reserved.
3 #
4 # This program and the accompanying materials are made available under the
5 # terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 # and is available at http://www.eclipse.org/legal/epl-v10.html
7 ##############################################################################
8
9 """Tests for package build logic helper library."""
10
11 import unittest
12
13 import lib
14
15
16 class TestExtractVersion(unittest.TestCase):
17
18     """Test logic to extract ODL versions from artifact URLs."""
19
20     nexus_url = "https://nexus.opendaylight.org/content/repositories"
21
22     def test_oxygen_release_url(self):
23         """Test URL of the ODL Oxygen release."""
24         url = "%s/repositories/opendaylight.release/org/opendaylight/integration/karaf/0.8.0/karaf-0.8.0.tar.gz" % self.nexus_url
25         version = lib.extract_version(url)
26         self.assertEqual(version["version_major"], "8")
27         self.assertEqual(version["version_minor"], "0")
28         self.assertEqual(version["version_patch"], "0")
29         self.assertEqual(version["pkg_version"], "1")
30         self.assertEqual(version["codename"], "")
31
32     def test_oxygen_release_zip_url(self):
33         """Test URL of the ODL Oxygen release zip archive."""
34         url = "%s/repositories/opendaylight.release/org/opendaylight/integration/karaf/0.8.0/karaf-0.8.0.zip" % self.nexus_url
35         version = lib.extract_version(url)
36         self.assertEqual(version["version_major"], "8")
37         self.assertEqual(version["version_minor"], "0")
38         self.assertEqual(version["version_patch"], "0")
39         self.assertEqual(version["pkg_version"], "1")
40         self.assertEqual(version["codename"], "")
41
42     def test_oxygen_sr1_url(self):
43         """Test URL of the ODL Oxygen SR2."""
44         url = "%s/repositories/opendaylight.release/org/opendaylight/integration/karaf/0.8.2/karaf-0.8.2.tar.gz" % self.nexus_url
45         version = lib.extract_version(url)
46         self.assertEqual(version["version_major"], "8")
47         self.assertEqual(version["version_minor"], "2")
48         self.assertEqual(version["version_patch"], "0")
49         self.assertEqual(version["pkg_version"], "1")
50         self.assertEqual(version["codename"], "")
51
52     def test_oxygen_sr1_zip_url(self):
53         """Test URL of the ODL Oxygen SR2 zip archive."""
54         url = "%s/repositories/opendaylight.release/org/opendaylight/integration/karaf/0.8.2/karaf-0.8.2.zip" % self.nexus_url
55         version = lib.extract_version(url)
56         self.assertEqual(version["version_major"], "8")
57         self.assertEqual(version["version_minor"], "2")
58         self.assertEqual(version["version_patch"], "0")
59         self.assertEqual(version["pkg_version"], "1")
60         self.assertEqual(version["codename"], "")
61
62     def test_oxygen_snapshot_url(self):
63         """Test URL of an ODL Oxygen snapshot build."""
64         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.8.0-SNAPSHOT/araf-0.8.0-20180202.194543-1393.tar.gz" % self.nexus_url
65         version = lib.extract_version(url)
66         self.assertEqual(version["version_major"], "8")
67         self.assertEqual(version["version_minor"], "0")
68         self.assertEqual(version["version_patch"], "0")
69         self.assertEqual(version["pkg_version"], "0.1.20180202snap1393")
70         self.assertEqual(version["codename"], "-SNAPSHOT")
71
72     def test_oxygen_snapshot_zip_url(self):
73         """Test URL of an ODL Oxygen snapshot build zip archive."""
74         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.8.0-SNAPSHOT/karaf-0.8.0-20180202.194543-1393.zip" % self.nexus_url
75         version = lib.extract_version(url)
76         self.assertEqual(version["version_major"], "8")
77         self.assertEqual(version["version_minor"], "0")
78         self.assertEqual(version["version_patch"], "0")
79         self.assertEqual(version["pkg_version"], "0.1.20180202snap1393")
80         self.assertEqual(version["codename"], "-SNAPSHOT")
81
82     def test_fluorine_snapshot_url(self):
83         """Test URL of an ODL Fluorine snapshot build."""
84         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.9.0-SNAPSHOT/karaf-0.9.0-20180411.203859-563.tar.gz" % self.nexus_url
85         version = lib.extract_version(url)
86         self.assertEqual(version["version_major"], "9")
87         self.assertEqual(version["version_minor"], "0")
88         self.assertEqual(version["version_patch"], "0")
89         self.assertEqual(version["pkg_version"], "0.1.20180411snap563")
90         self.assertEqual(version["codename"], "-SNAPSHOT")
91
92     def test_fluorine_snapshot_zip_url(self):
93         """Test URL of an ODL Fluorine snapshot build zip archive."""
94         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.9.0-SNAPSHOT/karaf-0.9.0-20180411.203859-563.tar.gz" % self.nexus_url
95         version = lib.extract_version(url)
96         self.assertEqual(version["version_major"], "9")
97         self.assertEqual(version["version_minor"], "0")
98         self.assertEqual(version["version_patch"], "0")
99         self.assertEqual(version["pkg_version"], "0.1.20180411snap563")
100         self.assertEqual(version["codename"], "-SNAPSHOT")
101
102     def test_neon_snapshot_url(self):
103         """Test URL of an ODL Neon snapshot build."""
104         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.10.0-SNAPSHOT/karaf-0.10.0-20181004.142605-697.tar.gz" % self.nexus_url
105         version = lib.extract_version(url)
106         self.assertEqual(version["version_major"], "10")
107         self.assertEqual(version["version_minor"], "0")
108         self.assertEqual(version["version_patch"], "0")
109         self.assertEqual(version["pkg_version"], "0.1.20181004snap697")
110         self.assertEqual(version["codename"], "-SNAPSHOT")
111
112     def test_neon_snapshot_zip_url(self):
113         """Test URL of an ODL Neon snapshot build zip archive."""
114         url = "%s/opendaylight.snapshot/org/opendaylight/integration/karaf/0.10.0-SNAPSHOT/karaf-0.10.0-20181004.142605-697.zip" % self.nexus_url
115         version = lib.extract_version(url)
116         self.assertEqual(version["version_major"], "10")
117         self.assertEqual(version["version_minor"], "0")
118         self.assertEqual(version["version_patch"], "0")
119         self.assertEqual(version["pkg_version"], "0.1.20181004snap697")
120         self.assertEqual(version["codename"], "-SNAPSHOT")
121
122     def test_oxygen_multipatch_zip_url(self):
123         """Test URL of an ODL Oxygen multipatch-test build zip archive."""
124         url = "%s/opendaylight.snapshot/org/opendaylight/integration/integration/distribution/karaf/0.8.0-SNAPSHOT/karaf-0.8.0-20180204.191936-134.zip" % self.nexus_url
125         version = lib.extract_version(url)
126         self.assertEqual(version["version_major"], "8")
127         self.assertEqual(version["version_minor"], "0")
128         self.assertEqual(version["version_patch"], "0")
129         self.assertEqual(version["pkg_version"], "0.1.20180204snap134")
130         self.assertEqual(version["codename"], "-SNAPSHOT")
131
132     def test_fluorine_multipatch_zip_url(self):
133         """Test URL of an ODL Fluorine multipatch-test build zip archive."""
134         url = "%s/opendaylight.snapshot/org/opendaylight/integration/integration/distribution/karaf/0.9.0-SNAPSHOT/karaf-0.9.0-20180531.192226-59.zip" % self.nexus_url
135         version = lib.extract_version(url)
136         self.assertEqual(version["version_major"], "9")
137         self.assertEqual(version["version_minor"], "0")
138         self.assertEqual(version["version_patch"], "0")
139         self.assertEqual(version["pkg_version"], "0.1.20180531snap59")
140         self.assertEqual(version["codename"], "-SNAPSHOT")
141
142     def test_neon_multipatch_zip_url(self):
143         """Test URL of an ODL Neon multipatch-test build zip archive."""
144         url = "%s/opendaylight.snapshot/org/opendaylight/integration/integration/distribution/karaf/0.10.0-SNAPSHOT/karaf-0.10.0-20180925.093600-5.zip" % self.nexus_url
145         version = lib.extract_version(url)
146         self.assertEqual(version["version_major"], "10")
147         self.assertEqual(version["version_minor"], "0")
148         self.assertEqual(version["version_patch"], "0")
149         self.assertEqual(version["pkg_version"], "0.1.20180925snap5")
150         self.assertEqual(version["codename"], "-SNAPSHOT")
151
152
153 class TestGetSnapURL(unittest.TestCase):
154
155     """Test logic get URL to latest snapshot build of given major version."""
156
157     url_base = "https://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/org/opendaylight/integration"
158
159     def validate_snap_url(self, snap_url):
160         """Helper for validating snapshot URLs are sane."""
161         self.assertIn(self.url_base, snap_url)
162         self.assertIn("tar.gz", snap_url)
163         self.assertNotIn("release", snap_url)
164         self.assertNotIn("public", snap_url)
165
166     def test_oxygen(self):
167         """Test Oxygen major version gives sane snapshot URL."""
168         self.validate_snap_url(lib.get_snap_url("8"))
169
170     def test_fluorine(self):
171         """Test Fluorine major version gives sane snapshot URL."""
172         self.validate_snap_url(lib.get_snap_url("9"))
173
174     def test_neon(self):
175         """Test Neon major version gives sane snapshot URL."""
176         self.validate_snap_url(lib.get_snap_url("10"))
177
178
179 class TestGetDistroNamePrefix(unittest.TestCase):
180
181     """Test logic to get Karaf 3/4 or Managed Release Common distro prefixes."""
182
183     mrel_distro_prefix = "opendaylight"
184     k4_distro_prefix = "karaf"
185     k3_distro_prefix = "distribution-karaf"
186     mrel_distro_url = "https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/integration/opendaylight/0.9.0/opendaylight-0.9.0.tar.gz"
187     k4_distro_url = "https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/integration/karaf/0.8.3/karaf-0.8.3.tar.gz"
188     k3_distro_url = "https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/integration/distribution-karaf/0.6.4-Carbon/distribution-karaf-0.6.4-Carbon.tar.gz"
189
190     def test_oxygen(self):
191         """Test Oxygen major version gives Karaf 4 prefix."""
192         distro_prefix = lib.get_distro_name_prefix("8")
193         self.assertEqual(distro_prefix, self.k4_distro_prefix)
194
195     def test_oxygen_int(self):
196         """Test Oxygen major version as int gives Karaf 4 prefix."""
197         distro_prefix = lib.get_distro_name_prefix(8)
198         self.assertEqual(distro_prefix, self.k4_distro_prefix)
199
200     def test_fluorine(self):
201         """Test Fluorine major version gives Karaf 4 prefix."""
202         distro_prefix = lib.get_distro_name_prefix("9")
203         self.assertEqual(distro_prefix, self.k4_distro_prefix)
204
205     def test_fluorine_int(self):
206         """Test Fluorine major version as int gives Karaf 4 prefix."""
207         distro_prefix = lib.get_distro_name_prefix(9)
208         self.assertEqual(distro_prefix, self.k4_distro_prefix)
209
210     def test_neon(self):
211         """Test Neon major version gives Karaf 4 prefix."""
212         distro_prefix = lib.get_distro_name_prefix("10")
213         self.assertEqual(distro_prefix, self.k4_distro_prefix)
214
215     def test_neon_int(self):
216         """Test Neon major version as int gives Karaf 4 prefix."""
217         distro_prefix = lib.get_distro_name_prefix(10)
218         self.assertEqual(distro_prefix, self.k4_distro_prefix)
219
220     def test_managed_release_fluorine(self):
221         """Test Managed Release URL gives MR distro prefix."""
222         distro_prefix = lib.get_distro_name_prefix(9, self.mrel_distro_url)
223         self.assertEqual(distro_prefix, self.mrel_distro_prefix)
224
225     def test_k4_norm_release_oxygen(self):
226         """Test normal K4 URL gives distro prefix based on Karaf version."""
227         distro_prefix = lib.get_distro_name_prefix(9, self.k4_distro_url)
228         self.assertEqual(distro_prefix, self.k4_distro_prefix)
229
230     def test_k3_norm_release_carbon(self):
231         """Test normal K3 URL gives distro prefix based on Karaf version."""
232         distro_prefix = lib.get_distro_name_prefix(6, self.k3_distro_url)
233         self.assertEqual(distro_prefix, self.k3_distro_prefix)
234
235
236 class TestGetSysdCommit(unittest.TestCase):
237
238     """Test fn to get most recent Int/Pack hash to use as sysd file version."""
239
240     def test_type(self):
241         """Check that returned value is of the right type."""
242         sysd_hash = lib.get_sysd_commit()
243         self.assertIsInstance(sysd_hash, str)
244
245     def test_len(self):
246         """Check that returned value the normal length for a commit hash."""
247         sysd_hash = lib.get_sysd_commit()
248         self.assertEqual(len(sysd_hash), 40)
249
250     def test_only_valid_chars(self):
251         """Check that returned value only contains typical commit hash chars."""
252         sysd_hash = lib.get_sysd_commit()
253         self.assertRegexpMatches(sysd_hash, "^[A-Za-z0-9-]+$")
254
255
256 class TestGetJavaVersion(unittest.TestCase):
257
258     """Test fn to get Java version required for a given ODL version."""
259
260     def test_type_given_int(self):
261         """Pass int, check that returned value is of the right type."""
262         java_version = lib.get_java_version(6)
263         self.assertIsInstance(java_version, int)
264
265     def test_type_given_str(self):
266         """Pass str, check that returned value is of the right type."""
267         java_version = lib.get_java_version("6")
268         self.assertIsInstance(java_version, int)
269
270     def test_old_given_int(self):
271         """Pass old ODL major version as int, check that Java 7 returned."""
272         java_version = lib.get_java_version(4)
273         self.assertEqual(java_version, 7)
274
275     def test_old_given_str(self):
276         """Pass old ODL major version as str, check that Java 7 returned."""
277         java_version = lib.get_java_version("4")
278         self.assertEqual(java_version, 7)
279
280     def test_oxygen_given_int(self):
281         """Pass Oxygen major version as int, check that Java 8 returned."""
282         java_version = lib.get_java_version(8)
283         self.assertEqual(java_version, 8)
284
285     def test_oxygen_given_str(self):
286         """Pass Oxygen major version as str, check that Java 8 returned."""
287         java_version = lib.get_java_version("8")
288         self.assertEqual(java_version, 8)
289
290     def test_fluorine_given_int(self):
291         """Pass Fluorine major version as int, check that Java 8 returned."""
292         java_version = lib.get_java_version(9)
293         self.assertEqual(java_version, 8)
294
295     def test_fluorine_given_str(self):
296         """Pass Fluorine major version as str, check that Java 8 returned."""
297         java_version = lib.get_java_version("9")
298         self.assertEqual(java_version, 8)
299
300     def test_neon_given_int(self):
301         """Pass Neon major version as int, check that Java 8 returned."""
302         java_version = lib.get_java_version(10)
303         self.assertEqual(java_version, 8)
304
305     def test_neon_given_str(self):
306         """Pass Neon major version as str, check that Java 8 returned."""
307         java_version = lib.get_java_version("10")
308         self.assertEqual(java_version, 8)
309
310
311 class TestGetChangelogDate(unittest.TestCase):
312
313     """Test lib fn that gives date for changelog in RPM or Deb format."""
314
315     def test_type_rpm(self):
316         """Test type of return object is correct given RPM arg."""
317         changelog_date = lib.get_changelog_date("rpm")
318         self.assertIsInstance(changelog_date, str)
319
320     def test_type_deb(self):
321         """Test type of return object is correct given Deb arg."""
322         changelog_date = lib.get_changelog_date("deb")
323         self.assertIsInstance(changelog_date, str)
324
325     def test_has_year_rpm(self):
326         """Test returned value has a year in it given RPM arg."""
327         changelog_date = lib.get_changelog_date("rpm")
328         self.assertRegexpMatches(changelog_date, "[20]\d\d")
329
330     def test_has_year_deb(self):
331         """Test returned value has a year in it given Deb arg."""
332         changelog_date = lib.get_changelog_date("deb")
333         self.assertRegexpMatches(changelog_date, "[20]\d\d")
334
335     def test_has_month_rpm(self):
336         """Test returned value has a month in it given RPM arg."""
337         changelog_date = lib.get_changelog_date("rpm")
338         self.assertRegexpMatches(
339             changelog_date,
340             "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec")
341
342     def test_has_month_deb(self):
343         """Test returned value has a month in it given Deb arg."""
344         changelog_date = lib.get_changelog_date("deb")
345         self.assertRegexpMatches(
346             changelog_date,
347             "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec")
348
349     def test_has_day_rpm(self):
350         """Test returned value has a day in it given RPM arg."""
351         changelog_date = lib.get_changelog_date("rpm")
352         self.assertRegexpMatches(
353             changelog_date,
354             "Mon|Tue|Wed|Thu|Fri|Sat|Sun")
355
356     def test_has_day_deb(self):
357         """Test returned value has a day in it given Deb arg."""
358         changelog_date = lib.get_changelog_date("deb")
359         self.assertRegexpMatches(
360             changelog_date,
361             "Mon|Tue|Wed|Thu|Fri|Sat|Sun")