Merge ~axino/charm-k8s-gunicorn/+git/charm-k8s-gunicorn:axino into charm-k8s-gunicorn:master
- Git
- lp:~axino/charm-k8s-gunicorn/+git/charm-k8s-gunicorn
- axino
- Merge into master
Proposed by
Junien F
Status: | Merged |
---|---|
Approved by: | Junien F |
Approved revision: | b5ee9b78b152f5415175b104dd5c1612d3816596 |
Merged at revision: | 42db9435b485d4a470495975004319445f5cf966 |
Proposed branch: | ~axino/charm-k8s-gunicorn/+git/charm-k8s-gunicorn:axino |
Merge into: | charm-k8s-gunicorn:master |
Diff against target: |
1317 lines (+1209/-0) 18 files modified
.flake8 (+9/-0) .gitignore (+8/-0) .jujuignore (+6/-0) LICENSE (+674/-0) Makefile (+23/-0) README.md (+14/-0) config.yaml (+18/-0) docker/app/Dockerfile (+12/-0) docker/app/app/app.py (+7/-0) docker/gunicorn-base/Dockerfile (+18/-0) docker/gunicorn-base/run (+15/-0) metadata.yaml (+9/-0) requirements.txt (+1/-0) src/charm.py (+144/-0) tests/unit/requirements.txt (+4/-0) tests/unit/scenario.py (+98/-0) tests/unit/test_charm.py (+100/-0) tox.ini (+49/-0) |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
John Lenton (community) | Approve | ||
Stuart Bishop (community) | Approve | ||
gunicorn-charmers | Pending | ||
Review via email: mp+389554@code.launchpad.net |
Commit message
Initial commit
Description of the change
To post a comment you must log in.
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote : | # |
Revision history for this message
Tom Haddon (mthaddon) wrote : | # |
Some comments inline, overall looks good.
Revision history for this message
Tom Haddon (mthaddon) wrote : | # |
A few small comments inline
Revision history for this message
John Lenton (chipaca) wrote : | # |
This seems fine.
I need to find out more about status vs pod.set_spec transactionality (see inline).
Revision history for this message
Stuart Bishop (stub) : | # |
Revision history for this message
Stuart Bishop (stub) wrote : | # |
Code looks good. Lots of inline comments, almost all stylistic and subjective (not required changes).
review:
Approve
Revision history for this message
John Lenton (chipaca) : | # |
review:
Approve
Revision history for this message
Junien F (axino) wrote : | # |
Replied inline
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote : | # |
Change successfully merged at revision 42db9435b485d4a
Revision history for this message
Stuart Bishop (stub) : | # |
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | diff --git a/.flake8 b/.flake8 |
2 | new file mode 100644 |
3 | index 0000000..41512a8 |
4 | --- /dev/null |
5 | +++ b/.flake8 |
6 | @@ -0,0 +1,9 @@ |
7 | +[flake8] |
8 | +max-line-length = 120 |
9 | +select: E,W,F,C,N |
10 | +exclude: |
11 | + venv |
12 | + .git |
13 | + build |
14 | + dist |
15 | + *.egg_info |
16 | diff --git a/.gitignore b/.gitignore |
17 | new file mode 100644 |
18 | index 0000000..58a7dc6 |
19 | --- /dev/null |
20 | +++ b/.gitignore |
21 | @@ -0,0 +1,8 @@ |
22 | +*~ |
23 | +*swp |
24 | +*.charm |
25 | +.tox |
26 | +.coverage |
27 | +__pycache__ |
28 | +build |
29 | +venv |
30 | diff --git a/.jujuignore b/.jujuignore |
31 | new file mode 100644 |
32 | index 0000000..423f33d |
33 | --- /dev/null |
34 | +++ b/.jujuignore |
35 | @@ -0,0 +1,6 @@ |
36 | +/env |
37 | +*.py[cod] |
38 | +*.charm |
39 | +docker |
40 | +*swp |
41 | +venv |
42 | diff --git a/LICENSE b/LICENSE |
43 | new file mode 100644 |
44 | index 0000000..94a9ed0 |
45 | --- /dev/null |
46 | +++ b/LICENSE |
47 | @@ -0,0 +1,674 @@ |
48 | + GNU GENERAL PUBLIC LICENSE |
49 | + Version 3, 29 June 2007 |
50 | + |
51 | + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
52 | + Everyone is permitted to copy and distribute verbatim copies |
53 | + of this license document, but changing it is not allowed. |
54 | + |
55 | + Preamble |
56 | + |
57 | + The GNU General Public License is a free, copyleft license for |
58 | +software and other kinds of works. |
59 | + |
60 | + The licenses for most software and other practical works are designed |
61 | +to take away your freedom to share and change the works. By contrast, |
62 | +the GNU General Public License is intended to guarantee your freedom to |
63 | +share and change all versions of a program--to make sure it remains free |
64 | +software for all its users. We, the Free Software Foundation, use the |
65 | +GNU General Public License for most of our software; it applies also to |
66 | +any other work released this way by its authors. You can apply it to |
67 | +your programs, too. |
68 | + |
69 | + When we speak of free software, we are referring to freedom, not |
70 | +price. Our General Public Licenses are designed to make sure that you |
71 | +have the freedom to distribute copies of free software (and charge for |
72 | +them if you wish), that you receive source code or can get it if you |
73 | +want it, that you can change the software or use pieces of it in new |
74 | +free programs, and that you know you can do these things. |
75 | + |
76 | + To protect your rights, we need to prevent others from denying you |
77 | +these rights or asking you to surrender the rights. Therefore, you have |
78 | +certain responsibilities if you distribute copies of the software, or if |
79 | +you modify it: responsibilities to respect the freedom of others. |
80 | + |
81 | + For example, if you distribute copies of such a program, whether |
82 | +gratis or for a fee, you must pass on to the recipients the same |
83 | +freedoms that you received. You must make sure that they, too, receive |
84 | +or can get the source code. And you must show them these terms so they |
85 | +know their rights. |
86 | + |
87 | + Developers that use the GNU GPL protect your rights with two steps: |
88 | +(1) assert copyright on the software, and (2) offer you this License |
89 | +giving you legal permission to copy, distribute and/or modify it. |
90 | + |
91 | + For the developers' and authors' protection, the GPL clearly explains |
92 | +that there is no warranty for this free software. For both users' and |
93 | +authors' sake, the GPL requires that modified versions be marked as |
94 | +changed, so that their problems will not be attributed erroneously to |
95 | +authors of previous versions. |
96 | + |
97 | + Some devices are designed to deny users access to install or run |
98 | +modified versions of the software inside them, although the manufacturer |
99 | +can do so. This is fundamentally incompatible with the aim of |
100 | +protecting users' freedom to change the software. The systematic |
101 | +pattern of such abuse occurs in the area of products for individuals to |
102 | +use, which is precisely where it is most unacceptable. Therefore, we |
103 | +have designed this version of the GPL to prohibit the practice for those |
104 | +products. If such problems arise substantially in other domains, we |
105 | +stand ready to extend this provision to those domains in future versions |
106 | +of the GPL, as needed to protect the freedom of users. |
107 | + |
108 | + Finally, every program is threatened constantly by software patents. |
109 | +States should not allow patents to restrict development and use of |
110 | +software on general-purpose computers, but in those that do, we wish to |
111 | +avoid the special danger that patents applied to a free program could |
112 | +make it effectively proprietary. To prevent this, the GPL assures that |
113 | +patents cannot be used to render the program non-free. |
114 | + |
115 | + The precise terms and conditions for copying, distribution and |
116 | +modification follow. |
117 | + |
118 | + TERMS AND CONDITIONS |
119 | + |
120 | + 0. Definitions. |
121 | + |
122 | + "This License" refers to version 3 of the GNU General Public License. |
123 | + |
124 | + "Copyright" also means copyright-like laws that apply to other kinds of |
125 | +works, such as semiconductor masks. |
126 | + |
127 | + "The Program" refers to any copyrightable work licensed under this |
128 | +License. Each licensee is addressed as "you". "Licensees" and |
129 | +"recipients" may be individuals or organizations. |
130 | + |
131 | + To "modify" a work means to copy from or adapt all or part of the work |
132 | +in a fashion requiring copyright permission, other than the making of an |
133 | +exact copy. The resulting work is called a "modified version" of the |
134 | +earlier work or a work "based on" the earlier work. |
135 | + |
136 | + A "covered work" means either the unmodified Program or a work based |
137 | +on the Program. |
138 | + |
139 | + To "propagate" a work means to do anything with it that, without |
140 | +permission, would make you directly or secondarily liable for |
141 | +infringement under applicable copyright law, except executing it on a |
142 | +computer or modifying a private copy. Propagation includes copying, |
143 | +distribution (with or without modification), making available to the |
144 | +public, and in some countries other activities as well. |
145 | + |
146 | + To "convey" a work means any kind of propagation that enables other |
147 | +parties to make or receive copies. Mere interaction with a user through |
148 | +a computer network, with no transfer of a copy, is not conveying. |
149 | + |
150 | + An interactive user interface displays "Appropriate Legal Notices" |
151 | +to the extent that it includes a convenient and prominently visible |
152 | +feature that (1) displays an appropriate copyright notice, and (2) |
153 | +tells the user that there is no warranty for the work (except to the |
154 | +extent that warranties are provided), that licensees may convey the |
155 | +work under this License, and how to view a copy of this License. If |
156 | +the interface presents a list of user commands or options, such as a |
157 | +menu, a prominent item in the list meets this criterion. |
158 | + |
159 | + 1. Source Code. |
160 | + |
161 | + The "source code" for a work means the preferred form of the work |
162 | +for making modifications to it. "Object code" means any non-source |
163 | +form of a work. |
164 | + |
165 | + A "Standard Interface" means an interface that either is an official |
166 | +standard defined by a recognized standards body, or, in the case of |
167 | +interfaces specified for a particular programming language, one that |
168 | +is widely used among developers working in that language. |
169 | + |
170 | + The "System Libraries" of an executable work include anything, other |
171 | +than the work as a whole, that (a) is included in the normal form of |
172 | +packaging a Major Component, but which is not part of that Major |
173 | +Component, and (b) serves only to enable use of the work with that |
174 | +Major Component, or to implement a Standard Interface for which an |
175 | +implementation is available to the public in source code form. A |
176 | +"Major Component", in this context, means a major essential component |
177 | +(kernel, window system, and so on) of the specific operating system |
178 | +(if any) on which the executable work runs, or a compiler used to |
179 | +produce the work, or an object code interpreter used to run it. |
180 | + |
181 | + The "Corresponding Source" for a work in object code form means all |
182 | +the source code needed to generate, install, and (for an executable |
183 | +work) run the object code and to modify the work, including scripts to |
184 | +control those activities. However, it does not include the work's |
185 | +System Libraries, or general-purpose tools or generally available free |
186 | +programs which are used unmodified in performing those activities but |
187 | +which are not part of the work. For example, Corresponding Source |
188 | +includes interface definition files associated with source files for |
189 | +the work, and the source code for shared libraries and dynamically |
190 | +linked subprograms that the work is specifically designed to require, |
191 | +such as by intimate data communication or control flow between those |
192 | +subprograms and other parts of the work. |
193 | + |
194 | + The Corresponding Source need not include anything that users |
195 | +can regenerate automatically from other parts of the Corresponding |
196 | +Source. |
197 | + |
198 | + The Corresponding Source for a work in source code form is that |
199 | +same work. |
200 | + |
201 | + 2. Basic Permissions. |
202 | + |
203 | + All rights granted under this License are granted for the term of |
204 | +copyright on the Program, and are irrevocable provided the stated |
205 | +conditions are met. This License explicitly affirms your unlimited |
206 | +permission to run the unmodified Program. The output from running a |
207 | +covered work is covered by this License only if the output, given its |
208 | +content, constitutes a covered work. This License acknowledges your |
209 | +rights of fair use or other equivalent, as provided by copyright law. |
210 | + |
211 | + You may make, run and propagate covered works that you do not |
212 | +convey, without conditions so long as your license otherwise remains |
213 | +in force. You may convey covered works to others for the sole purpose |
214 | +of having them make modifications exclusively for you, or provide you |
215 | +with facilities for running those works, provided that you comply with |
216 | +the terms of this License in conveying all material for which you do |
217 | +not control copyright. Those thus making or running the covered works |
218 | +for you must do so exclusively on your behalf, under your direction |
219 | +and control, on terms that prohibit them from making any copies of |
220 | +your copyrighted material outside their relationship with you. |
221 | + |
222 | + Conveying under any other circumstances is permitted solely under |
223 | +the conditions stated below. Sublicensing is not allowed; section 10 |
224 | +makes it unnecessary. |
225 | + |
226 | + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
227 | + |
228 | + No covered work shall be deemed part of an effective technological |
229 | +measure under any applicable law fulfilling obligations under article |
230 | +11 of the WIPO copyright treaty adopted on 20 December 1996, or |
231 | +similar laws prohibiting or restricting circumvention of such |
232 | +measures. |
233 | + |
234 | + When you convey a covered work, you waive any legal power to forbid |
235 | +circumvention of technological measures to the extent such circumvention |
236 | +is effected by exercising rights under this License with respect to |
237 | +the covered work, and you disclaim any intention to limit operation or |
238 | +modification of the work as a means of enforcing, against the work's |
239 | +users, your or third parties' legal rights to forbid circumvention of |
240 | +technological measures. |
241 | + |
242 | + 4. Conveying Verbatim Copies. |
243 | + |
244 | + You may convey verbatim copies of the Program's source code as you |
245 | +receive it, in any medium, provided that you conspicuously and |
246 | +appropriately publish on each copy an appropriate copyright notice; |
247 | +keep intact all notices stating that this License and any |
248 | +non-permissive terms added in accord with section 7 apply to the code; |
249 | +keep intact all notices of the absence of any warranty; and give all |
250 | +recipients a copy of this License along with the Program. |
251 | + |
252 | + You may charge any price or no price for each copy that you convey, |
253 | +and you may offer support or warranty protection for a fee. |
254 | + |
255 | + 5. Conveying Modified Source Versions. |
256 | + |
257 | + You may convey a work based on the Program, or the modifications to |
258 | +produce it from the Program, in the form of source code under the |
259 | +terms of section 4, provided that you also meet all of these conditions: |
260 | + |
261 | + a) The work must carry prominent notices stating that you modified |
262 | + it, and giving a relevant date. |
263 | + |
264 | + b) The work must carry prominent notices stating that it is |
265 | + released under this License and any conditions added under section |
266 | + 7. This requirement modifies the requirement in section 4 to |
267 | + "keep intact all notices". |
268 | + |
269 | + c) You must license the entire work, as a whole, under this |
270 | + License to anyone who comes into possession of a copy. This |
271 | + License will therefore apply, along with any applicable section 7 |
272 | + additional terms, to the whole of the work, and all its parts, |
273 | + regardless of how they are packaged. This License gives no |
274 | + permission to license the work in any other way, but it does not |
275 | + invalidate such permission if you have separately received it. |
276 | + |
277 | + d) If the work has interactive user interfaces, each must display |
278 | + Appropriate Legal Notices; however, if the Program has interactive |
279 | + interfaces that do not display Appropriate Legal Notices, your |
280 | + work need not make them do so. |
281 | + |
282 | + A compilation of a covered work with other separate and independent |
283 | +works, which are not by their nature extensions of the covered work, |
284 | +and which are not combined with it such as to form a larger program, |
285 | +in or on a volume of a storage or distribution medium, is called an |
286 | +"aggregate" if the compilation and its resulting copyright are not |
287 | +used to limit the access or legal rights of the compilation's users |
288 | +beyond what the individual works permit. Inclusion of a covered work |
289 | +in an aggregate does not cause this License to apply to the other |
290 | +parts of the aggregate. |
291 | + |
292 | + 6. Conveying Non-Source Forms. |
293 | + |
294 | + You may convey a covered work in object code form under the terms |
295 | +of sections 4 and 5, provided that you also convey the |
296 | +machine-readable Corresponding Source under the terms of this License, |
297 | +in one of these ways: |
298 | + |
299 | + a) Convey the object code in, or embodied in, a physical product |
300 | + (including a physical distribution medium), accompanied by the |
301 | + Corresponding Source fixed on a durable physical medium |
302 | + customarily used for software interchange. |
303 | + |
304 | + b) Convey the object code in, or embodied in, a physical product |
305 | + (including a physical distribution medium), accompanied by a |
306 | + written offer, valid for at least three years and valid for as |
307 | + long as you offer spare parts or customer support for that product |
308 | + model, to give anyone who possesses the object code either (1) a |
309 | + copy of the Corresponding Source for all the software in the |
310 | + product that is covered by this License, on a durable physical |
311 | + medium customarily used for software interchange, for a price no |
312 | + more than your reasonable cost of physically performing this |
313 | + conveying of source, or (2) access to copy the |
314 | + Corresponding Source from a network server at no charge. |
315 | + |
316 | + c) Convey individual copies of the object code with a copy of the |
317 | + written offer to provide the Corresponding Source. This |
318 | + alternative is allowed only occasionally and noncommercially, and |
319 | + only if you received the object code with such an offer, in accord |
320 | + with subsection 6b. |
321 | + |
322 | + d) Convey the object code by offering access from a designated |
323 | + place (gratis or for a charge), and offer equivalent access to the |
324 | + Corresponding Source in the same way through the same place at no |
325 | + further charge. You need not require recipients to copy the |
326 | + Corresponding Source along with the object code. If the place to |
327 | + copy the object code is a network server, the Corresponding Source |
328 | + may be on a different server (operated by you or a third party) |
329 | + that supports equivalent copying facilities, provided you maintain |
330 | + clear directions next to the object code saying where to find the |
331 | + Corresponding Source. Regardless of what server hosts the |
332 | + Corresponding Source, you remain obligated to ensure that it is |
333 | + available for as long as needed to satisfy these requirements. |
334 | + |
335 | + e) Convey the object code using peer-to-peer transmission, provided |
336 | + you inform other peers where the object code and Corresponding |
337 | + Source of the work are being offered to the general public at no |
338 | + charge under subsection 6d. |
339 | + |
340 | + A separable portion of the object code, whose source code is excluded |
341 | +from the Corresponding Source as a System Library, need not be |
342 | +included in conveying the object code work. |
343 | + |
344 | + A "User Product" is either (1) a "consumer product", which means any |
345 | +tangible personal property which is normally used for personal, family, |
346 | +or household purposes, or (2) anything designed or sold for incorporation |
347 | +into a dwelling. In determining whether a product is a consumer product, |
348 | +doubtful cases shall be resolved in favor of coverage. For a particular |
349 | +product received by a particular user, "normally used" refers to a |
350 | +typical or common use of that class of product, regardless of the status |
351 | +of the particular user or of the way in which the particular user |
352 | +actually uses, or expects or is expected to use, the product. A product |
353 | +is a consumer product regardless of whether the product has substantial |
354 | +commercial, industrial or non-consumer uses, unless such uses represent |
355 | +the only significant mode of use of the product. |
356 | + |
357 | + "Installation Information" for a User Product means any methods, |
358 | +procedures, authorization keys, or other information required to install |
359 | +and execute modified versions of a covered work in that User Product from |
360 | +a modified version of its Corresponding Source. The information must |
361 | +suffice to ensure that the continued functioning of the modified object |
362 | +code is in no case prevented or interfered with solely because |
363 | +modification has been made. |
364 | + |
365 | + If you convey an object code work under this section in, or with, or |
366 | +specifically for use in, a User Product, and the conveying occurs as |
367 | +part of a transaction in which the right of possession and use of the |
368 | +User Product is transferred to the recipient in perpetuity or for a |
369 | +fixed term (regardless of how the transaction is characterized), the |
370 | +Corresponding Source conveyed under this section must be accompanied |
371 | +by the Installation Information. But this requirement does not apply |
372 | +if neither you nor any third party retains the ability to install |
373 | +modified object code on the User Product (for example, the work has |
374 | +been installed in ROM). |
375 | + |
376 | + The requirement to provide Installation Information does not include a |
377 | +requirement to continue to provide support service, warranty, or updates |
378 | +for a work that has been modified or installed by the recipient, or for |
379 | +the User Product in which it has been modified or installed. Access to a |
380 | +network may be denied when the modification itself materially and |
381 | +adversely affects the operation of the network or violates the rules and |
382 | +protocols for communication across the network. |
383 | + |
384 | + Corresponding Source conveyed, and Installation Information provided, |
385 | +in accord with this section must be in a format that is publicly |
386 | +documented (and with an implementation available to the public in |
387 | +source code form), and must require no special password or key for |
388 | +unpacking, reading or copying. |
389 | + |
390 | + 7. Additional Terms. |
391 | + |
392 | + "Additional permissions" are terms that supplement the terms of this |
393 | +License by making exceptions from one or more of its conditions. |
394 | +Additional permissions that are applicable to the entire Program shall |
395 | +be treated as though they were included in this License, to the extent |
396 | +that they are valid under applicable law. If additional permissions |
397 | +apply only to part of the Program, that part may be used separately |
398 | +under those permissions, but the entire Program remains governed by |
399 | +this License without regard to the additional permissions. |
400 | + |
401 | + When you convey a copy of a covered work, you may at your option |
402 | +remove any additional permissions from that copy, or from any part of |
403 | +it. (Additional permissions may be written to require their own |
404 | +removal in certain cases when you modify the work.) You may place |
405 | +additional permissions on material, added by you to a covered work, |
406 | +for which you have or can give appropriate copyright permission. |
407 | + |
408 | + Notwithstanding any other provision of this License, for material you |
409 | +add to a covered work, you may (if authorized by the copyright holders of |
410 | +that material) supplement the terms of this License with terms: |
411 | + |
412 | + a) Disclaiming warranty or limiting liability differently from the |
413 | + terms of sections 15 and 16 of this License; or |
414 | + |
415 | + b) Requiring preservation of specified reasonable legal notices or |
416 | + author attributions in that material or in the Appropriate Legal |
417 | + Notices displayed by works containing it; or |
418 | + |
419 | + c) Prohibiting misrepresentation of the origin of that material, or |
420 | + requiring that modified versions of such material be marked in |
421 | + reasonable ways as different from the original version; or |
422 | + |
423 | + d) Limiting the use for publicity purposes of names of licensors or |
424 | + authors of the material; or |
425 | + |
426 | + e) Declining to grant rights under trademark law for use of some |
427 | + trade names, trademarks, or service marks; or |
428 | + |
429 | + f) Requiring indemnification of licensors and authors of that |
430 | + material by anyone who conveys the material (or modified versions of |
431 | + it) with contractual assumptions of liability to the recipient, for |
432 | + any liability that these contractual assumptions directly impose on |
433 | + those licensors and authors. |
434 | + |
435 | + All other non-permissive additional terms are considered "further |
436 | +restrictions" within the meaning of section 10. If the Program as you |
437 | +received it, or any part of it, contains a notice stating that it is |
438 | +governed by this License along with a term that is a further |
439 | +restriction, you may remove that term. If a license document contains |
440 | +a further restriction but permits relicensing or conveying under this |
441 | +License, you may add to a covered work material governed by the terms |
442 | +of that license document, provided that the further restriction does |
443 | +not survive such relicensing or conveying. |
444 | + |
445 | + If you add terms to a covered work in accord with this section, you |
446 | +must place, in the relevant source files, a statement of the |
447 | +additional terms that apply to those files, or a notice indicating |
448 | +where to find the applicable terms. |
449 | + |
450 | + Additional terms, permissive or non-permissive, may be stated in the |
451 | +form of a separately written license, or stated as exceptions; |
452 | +the above requirements apply either way. |
453 | + |
454 | + 8. Termination. |
455 | + |
456 | + You may not propagate or modify a covered work except as expressly |
457 | +provided under this License. Any attempt otherwise to propagate or |
458 | +modify it is void, and will automatically terminate your rights under |
459 | +this License (including any patent licenses granted under the third |
460 | +paragraph of section 11). |
461 | + |
462 | + However, if you cease all violation of this License, then your |
463 | +license from a particular copyright holder is reinstated (a) |
464 | +provisionally, unless and until the copyright holder explicitly and |
465 | +finally terminates your license, and (b) permanently, if the copyright |
466 | +holder fails to notify you of the violation by some reasonable means |
467 | +prior to 60 days after the cessation. |
468 | + |
469 | + Moreover, your license from a particular copyright holder is |
470 | +reinstated permanently if the copyright holder notifies you of the |
471 | +violation by some reasonable means, this is the first time you have |
472 | +received notice of violation of this License (for any work) from that |
473 | +copyright holder, and you cure the violation prior to 30 days after |
474 | +your receipt of the notice. |
475 | + |
476 | + Termination of your rights under this section does not terminate the |
477 | +licenses of parties who have received copies or rights from you under |
478 | +this License. If your rights have been terminated and not permanently |
479 | +reinstated, you do not qualify to receive new licenses for the same |
480 | +material under section 10. |
481 | + |
482 | + 9. Acceptance Not Required for Having Copies. |
483 | + |
484 | + You are not required to accept this License in order to receive or |
485 | +run a copy of the Program. Ancillary propagation of a covered work |
486 | +occurring solely as a consequence of using peer-to-peer transmission |
487 | +to receive a copy likewise does not require acceptance. However, |
488 | +nothing other than this License grants you permission to propagate or |
489 | +modify any covered work. These actions infringe copyright if you do |
490 | +not accept this License. Therefore, by modifying or propagating a |
491 | +covered work, you indicate your acceptance of this License to do so. |
492 | + |
493 | + 10. Automatic Licensing of Downstream Recipients. |
494 | + |
495 | + Each time you convey a covered work, the recipient automatically |
496 | +receives a license from the original licensors, to run, modify and |
497 | +propagate that work, subject to this License. You are not responsible |
498 | +for enforcing compliance by third parties with this License. |
499 | + |
500 | + An "entity transaction" is a transaction transferring control of an |
501 | +organization, or substantially all assets of one, or subdividing an |
502 | +organization, or merging organizations. If propagation of a covered |
503 | +work results from an entity transaction, each party to that |
504 | +transaction who receives a copy of the work also receives whatever |
505 | +licenses to the work the party's predecessor in interest had or could |
506 | +give under the previous paragraph, plus a right to possession of the |
507 | +Corresponding Source of the work from the predecessor in interest, if |
508 | +the predecessor has it or can get it with reasonable efforts. |
509 | + |
510 | + You may not impose any further restrictions on the exercise of the |
511 | +rights granted or affirmed under this License. For example, you may |
512 | +not impose a license fee, royalty, or other charge for exercise of |
513 | +rights granted under this License, and you may not initiate litigation |
514 | +(including a cross-claim or counterclaim in a lawsuit) alleging that |
515 | +any patent claim is infringed by making, using, selling, offering for |
516 | +sale, or importing the Program or any portion of it. |
517 | + |
518 | + 11. Patents. |
519 | + |
520 | + A "contributor" is a copyright holder who authorizes use under this |
521 | +License of the Program or a work on which the Program is based. The |
522 | +work thus licensed is called the contributor's "contributor version". |
523 | + |
524 | + A contributor's "essential patent claims" are all patent claims |
525 | +owned or controlled by the contributor, whether already acquired or |
526 | +hereafter acquired, that would be infringed by some manner, permitted |
527 | +by this License, of making, using, or selling its contributor version, |
528 | +but do not include claims that would be infringed only as a |
529 | +consequence of further modification of the contributor version. For |
530 | +purposes of this definition, "control" includes the right to grant |
531 | +patent sublicenses in a manner consistent with the requirements of |
532 | +this License. |
533 | + |
534 | + Each contributor grants you a non-exclusive, worldwide, royalty-free |
535 | +patent license under the contributor's essential patent claims, to |
536 | +make, use, sell, offer for sale, import and otherwise run, modify and |
537 | +propagate the contents of its contributor version. |
538 | + |
539 | + In the following three paragraphs, a "patent license" is any express |
540 | +agreement or commitment, however denominated, not to enforce a patent |
541 | +(such as an express permission to practice a patent or covenant not to |
542 | +sue for patent infringement). To "grant" such a patent license to a |
543 | +party means to make such an agreement or commitment not to enforce a |
544 | +patent against the party. |
545 | + |
546 | + If you convey a covered work, knowingly relying on a patent license, |
547 | +and the Corresponding Source of the work is not available for anyone |
548 | +to copy, free of charge and under the terms of this License, through a |
549 | +publicly available network server or other readily accessible means, |
550 | +then you must either (1) cause the Corresponding Source to be so |
551 | +available, or (2) arrange to deprive yourself of the benefit of the |
552 | +patent license for this particular work, or (3) arrange, in a manner |
553 | +consistent with the requirements of this License, to extend the patent |
554 | +license to downstream recipients. "Knowingly relying" means you have |
555 | +actual knowledge that, but for the patent license, your conveying the |
556 | +covered work in a country, or your recipient's use of the covered work |
557 | +in a country, would infringe one or more identifiable patents in that |
558 | +country that you have reason to believe are valid. |
559 | + |
560 | + If, pursuant to or in connection with a single transaction or |
561 | +arrangement, you convey, or propagate by procuring conveyance of, a |
562 | +covered work, and grant a patent license to some of the parties |
563 | +receiving the covered work authorizing them to use, propagate, modify |
564 | +or convey a specific copy of the covered work, then the patent license |
565 | +you grant is automatically extended to all recipients of the covered |
566 | +work and works based on it. |
567 | + |
568 | + A patent license is "discriminatory" if it does not include within |
569 | +the scope of its coverage, prohibits the exercise of, or is |
570 | +conditioned on the non-exercise of one or more of the rights that are |
571 | +specifically granted under this License. You may not convey a covered |
572 | +work if you are a party to an arrangement with a third party that is |
573 | +in the business of distributing software, under which you make payment |
574 | +to the third party based on the extent of your activity of conveying |
575 | +the work, and under which the third party grants, to any of the |
576 | +parties who would receive the covered work from you, a discriminatory |
577 | +patent license (a) in connection with copies of the covered work |
578 | +conveyed by you (or copies made from those copies), or (b) primarily |
579 | +for and in connection with specific products or compilations that |
580 | +contain the covered work, unless you entered into that arrangement, |
581 | +or that patent license was granted, prior to 28 March 2007. |
582 | + |
583 | + Nothing in this License shall be construed as excluding or limiting |
584 | +any implied license or other defenses to infringement that may |
585 | +otherwise be available to you under applicable patent law. |
586 | + |
587 | + 12. No Surrender of Others' Freedom. |
588 | + |
589 | + If conditions are imposed on you (whether by court order, agreement or |
590 | +otherwise) that contradict the conditions of this License, they do not |
591 | +excuse you from the conditions of this License. If you cannot convey a |
592 | +covered work so as to satisfy simultaneously your obligations under this |
593 | +License and any other pertinent obligations, then as a consequence you may |
594 | +not convey it at all. For example, if you agree to terms that obligate you |
595 | +to collect a royalty for further conveying from those to whom you convey |
596 | +the Program, the only way you could satisfy both those terms and this |
597 | +License would be to refrain entirely from conveying the Program. |
598 | + |
599 | + 13. Use with the GNU Affero General Public License. |
600 | + |
601 | + Notwithstanding any other provision of this License, you have |
602 | +permission to link or combine any covered work with a work licensed |
603 | +under version 3 of the GNU Affero General Public License into a single |
604 | +combined work, and to convey the resulting work. The terms of this |
605 | +License will continue to apply to the part which is the covered work, |
606 | +but the special requirements of the GNU Affero General Public License, |
607 | +section 13, concerning interaction through a network will apply to the |
608 | +combination as such. |
609 | + |
610 | + 14. Revised Versions of this License. |
611 | + |
612 | + The Free Software Foundation may publish revised and/or new versions of |
613 | +the GNU General Public License from time to time. Such new versions will |
614 | +be similar in spirit to the present version, but may differ in detail to |
615 | +address new problems or concerns. |
616 | + |
617 | + Each version is given a distinguishing version number. If the |
618 | +Program specifies that a certain numbered version of the GNU General |
619 | +Public License "or any later version" applies to it, you have the |
620 | +option of following the terms and conditions either of that numbered |
621 | +version or of any later version published by the Free Software |
622 | +Foundation. If the Program does not specify a version number of the |
623 | +GNU General Public License, you may choose any version ever published |
624 | +by the Free Software Foundation. |
625 | + |
626 | + If the Program specifies that a proxy can decide which future |
627 | +versions of the GNU General Public License can be used, that proxy's |
628 | +public statement of acceptance of a version permanently authorizes you |
629 | +to choose that version for the Program. |
630 | + |
631 | + Later license versions may give you additional or different |
632 | +permissions. However, no additional obligations are imposed on any |
633 | +author or copyright holder as a result of your choosing to follow a |
634 | +later version. |
635 | + |
636 | + 15. Disclaimer of Warranty. |
637 | + |
638 | + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
639 | +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
640 | +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
641 | +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
642 | +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
643 | +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
644 | +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
645 | +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
646 | + |
647 | + 16. Limitation of Liability. |
648 | + |
649 | + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
650 | +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
651 | +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
652 | +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
653 | +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
654 | +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
655 | +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
656 | +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
657 | +SUCH DAMAGES. |
658 | + |
659 | + 17. Interpretation of Sections 15 and 16. |
660 | + |
661 | + If the disclaimer of warranty and limitation of liability provided |
662 | +above cannot be given local legal effect according to their terms, |
663 | +reviewing courts shall apply local law that most closely approximates |
664 | +an absolute waiver of all civil liability in connection with the |
665 | +Program, unless a warranty or assumption of liability accompanies a |
666 | +copy of the Program in return for a fee. |
667 | + |
668 | + END OF TERMS AND CONDITIONS |
669 | + |
670 | + How to Apply These Terms to Your New Programs |
671 | + |
672 | + If you develop a new program, and you want it to be of the greatest |
673 | +possible use to the public, the best way to achieve this is to make it |
674 | +free software which everyone can redistribute and change under these terms. |
675 | + |
676 | + To do so, attach the following notices to the program. It is safest |
677 | +to attach them to the start of each source file to most effectively |
678 | +state the exclusion of warranty; and each file should have at least |
679 | +the "copyright" line and a pointer to where the full notice is found. |
680 | + |
681 | + <one line to give the program's name and a brief idea of what it does.> |
682 | + Copyright (C) <year> <name of author> |
683 | + |
684 | + This program is free software: you can redistribute it and/or modify |
685 | + it under the terms of the GNU General Public License as published by |
686 | + the Free Software Foundation, either version 3 of the License, or |
687 | + (at your option) any later version. |
688 | + |
689 | + This program is distributed in the hope that it will be useful, |
690 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
691 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
692 | + GNU General Public License for more details. |
693 | + |
694 | + You should have received a copy of the GNU General Public License |
695 | + along with this program. If not, see <http://www.gnu.org/licenses/>. |
696 | + |
697 | +Also add information on how to contact you by electronic and paper mail. |
698 | + |
699 | + If the program does terminal interaction, make it output a short |
700 | +notice like this when it starts in an interactive mode: |
701 | + |
702 | + <program> Copyright (C) <year> <name of author> |
703 | + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
704 | + This is free software, and you are welcome to redistribute it |
705 | + under certain conditions; type `show c' for details. |
706 | + |
707 | +The hypothetical commands `show w' and `show c' should show the appropriate |
708 | +parts of the General Public License. Of course, your program's commands |
709 | +might be different; for a GUI interface, you would use an "about box". |
710 | + |
711 | + You should also get your employer (if you work as a programmer) or school, |
712 | +if any, to sign a "copyright disclaimer" for the program, if necessary. |
713 | +For more information on this, and how to apply and follow the GNU GPL, see |
714 | +<http://www.gnu.org/licenses/>. |
715 | + |
716 | + The GNU General Public License does not permit incorporating your program |
717 | +into proprietary programs. If your program is a subroutine library, you |
718 | +may consider it more useful to permit linking proprietary applications with |
719 | +the library. If this is what you want to do, use the GNU Lesser General |
720 | +Public License instead of this License. But first, please read |
721 | +<http://www.gnu.org/philosophy/why-not-lgpl.html>. |
722 | diff --git a/Makefile b/Makefile |
723 | new file mode 100644 |
724 | index 0000000..3e1801a |
725 | --- /dev/null |
726 | +++ b/Makefile |
727 | @@ -0,0 +1,23 @@ |
728 | +blacken: |
729 | + @echo "Normalising python layout with black." |
730 | + @tox -e black |
731 | + |
732 | +lint: blacken |
733 | + @echo "Running flake8" |
734 | + @tox -e lint |
735 | + |
736 | +# We actually use the build directory created by charmcraft, |
737 | +# but the .charm file makes a much more convenient sentinel. |
738 | +unittest: gunicorn.charm |
739 | + @tox -e unit |
740 | + |
741 | +test: lint unittest |
742 | + |
743 | +clean: |
744 | + @echo "Cleaning files" |
745 | + @git clean -fXd |
746 | + |
747 | +gunicorn.charm: src/*.py requirements.txt |
748 | + charmcraft build |
749 | + |
750 | +.PHONY: lint test unittest clean |
751 | diff --git a/README.md b/README.md |
752 | new file mode 100644 |
753 | index 0000000..646cbc9 |
754 | --- /dev/null |
755 | +++ b/README.md |
756 | @@ -0,0 +1,14 @@ |
757 | +# charm-k8s-gunicorn |
758 | + |
759 | +## Description |
760 | + |
761 | +A charm that allows you to deploy your gunicorn application in kubernetes. |
762 | + |
763 | +## Usage |
764 | + |
765 | +juju deploy cs:gunicorn my-awesome-app |
766 | +juju config my-awesome-app image\_path=localhost:32000/myapp |
767 | + |
768 | +### Scale Out Usage |
769 | + |
770 | +juju add-unit my-awesome-app |
771 | diff --git a/config.yaml b/config.yaml |
772 | new file mode 100644 |
773 | index 0000000..f93684c |
774 | --- /dev/null |
775 | +++ b/config.yaml |
776 | @@ -0,0 +1,18 @@ |
777 | +options: |
778 | + image_path: |
779 | + type: string |
780 | + description: | |
781 | + The location of the image to use, e.g. "registry.example.com/my_gunicorn_app:v1". |
782 | + |
783 | + This setting is required. |
784 | + default: '' |
785 | + image_username: |
786 | + type: string |
787 | + description: | |
788 | + The username for accessing the registry specified in image_path. |
789 | + default: '' |
790 | + image_password: |
791 | + type: string |
792 | + description: | |
793 | + The password associated with image_username for accessing the registry specified in image_path. |
794 | + default: '' |
795 | diff --git a/docker/app/Dockerfile b/docker/app/Dockerfile |
796 | new file mode 100644 |
797 | index 0000000..0b22a9c |
798 | --- /dev/null |
799 | +++ b/docker/app/Dockerfile |
800 | @@ -0,0 +1,12 @@ |
801 | +FROM gunicorn-base:latest |
802 | + |
803 | +RUN apt-get update \ |
804 | +&& apt-get install -y --no-install-recommends python3-psycopg2 \ |
805 | +&& apt-get clean \ |
806 | +&& rm -rf /var/cache/apt/archives/* /var/lib/apt/lists/* |
807 | + |
808 | +ENV APP_WSGI app:app |
809 | +ENV APP_NAME my-awesome-app |
810 | + |
811 | +WORKDIR /srv/gunicorn/ |
812 | +COPY app . |
813 | diff --git a/docker/app/app/app.py b/docker/app/app/app.py |
814 | new file mode 100644 |
815 | index 0000000..7044816 |
816 | --- /dev/null |
817 | +++ b/docker/app/app/app.py |
818 | @@ -0,0 +1,7 @@ |
819 | +import os |
820 | + |
821 | +def app(environ, start_response): |
822 | + status = '200 OK' |
823 | + response_headers = [('Content-type','text/plain')] |
824 | + start_response(status, response_headers) |
825 | + return [b'One of the nice things about the new operator framework is how easy it is to get started.\n'] |
826 | diff --git a/docker/gunicorn-base/Dockerfile b/docker/gunicorn-base/Dockerfile |
827 | new file mode 100644 |
828 | index 0000000..ef17e73 |
829 | --- /dev/null |
830 | +++ b/docker/gunicorn-base/Dockerfile |
831 | @@ -0,0 +1,18 @@ |
832 | +FROM ubuntu:latest |
833 | + |
834 | +ENV DEBIAN_FRONTEND noninteractive |
835 | + |
836 | +RUN apt-get update \ |
837 | +&& apt-get upgrade -y \ |
838 | +&& apt-get install -y --no-install-recommends gunicorn \ |
839 | +&& apt-get clean \ |
840 | +&& rm -rf /var/cache/apt/archives/* /var/lib/apt/lists/* |
841 | + |
842 | +WORKDIR /srv/gunicorn/ |
843 | + |
844 | +COPY run . |
845 | +RUN chmod +x run |
846 | + |
847 | +EXPOSE 80 |
848 | + |
849 | +CMD /srv/gunicorn/run |
850 | diff --git a/docker/gunicorn-base/run b/docker/gunicorn-base/run |
851 | new file mode 100644 |
852 | index 0000000..e73abf7 |
853 | --- /dev/null |
854 | +++ b/docker/gunicorn-base/run |
855 | @@ -0,0 +1,15 @@ |
856 | +#!/bin/bash |
857 | + |
858 | +exec gunicorn $APP_WSGI \ |
859 | + --name=$APP_NAME \ |
860 | + --bind=${BIND:-0.0.0.0:80} \ |
861 | + --workers=${APP_WORKERS:-1} \ |
862 | + --worker-class=${WORKER_CLASS:-sync} \ |
863 | + --worker-connections=${WORKER_CONNECTIONS:-1000} \ |
864 | + --backlog=${BACKLOG:-2048} \ |
865 | + --max-requests=${MAX_REQUESTS:-0} \ |
866 | + --timeout=${TIMEOUT:-30} \ |
867 | + --graceful-timeout=${GRACEFUL_TIMEOUT:-30} \ |
868 | + --keep-alive=${KEEPALIVE:-2} \ |
869 | + --pythonpath=/srv/gunicorn/ \ |
870 | + --proxy-allow-from='*' |
871 | diff --git a/metadata.yaml b/metadata.yaml |
872 | new file mode 100644 |
873 | index 0000000..3cbca9b |
874 | --- /dev/null |
875 | +++ b/metadata.yaml |
876 | @@ -0,0 +1,9 @@ |
877 | +# Copyright 2020 Canonical Ltd. |
878 | +# See LICENSE file for licensing details. |
879 | +name: gunicorn |
880 | +description: | |
881 | + Gunicorn charm |
882 | +summary: | |
883 | + Gunicorn charm |
884 | +series: [kubernetes] |
885 | +min-juju-version: 2.8.0 # charm storage in state |
886 | diff --git a/requirements.txt b/requirements.txt |
887 | new file mode 100644 |
888 | index 0000000..2d81d3b |
889 | --- /dev/null |
890 | +++ b/requirements.txt |
891 | @@ -0,0 +1 @@ |
892 | +ops |
893 | diff --git a/src/charm.py b/src/charm.py |
894 | new file mode 100755 |
895 | index 0000000..ecdd359 |
896 | --- /dev/null |
897 | +++ b/src/charm.py |
898 | @@ -0,0 +1,144 @@ |
899 | +#!/usr/bin/env python3 |
900 | +# Copyright 2020 Canonical Ltd. |
901 | +# See LICENSE file for licensing details. |
902 | + |
903 | +import logging |
904 | + |
905 | +import ops |
906 | +from ops.framework import StoredState |
907 | +from ops.charm import CharmBase |
908 | +from ops.main import main |
909 | +from ops.model import ( |
910 | + ActiveStatus, |
911 | + BlockedStatus, |
912 | + MaintenanceStatus, |
913 | +) |
914 | + |
915 | + |
916 | +logger = logging.getLogger(__name__) |
917 | + |
918 | +REQUIRED_JUJU_CONFIG = ['image_path'] |
919 | + |
920 | + |
921 | +class GunicornK8sCharmJujuConfigError(Exception): |
922 | + """Exception when the Juju config is bad.""" |
923 | + |
924 | + pass |
925 | + |
926 | + |
927 | +class GunicornK8sCharm(CharmBase): |
928 | + _stored = StoredState() |
929 | + |
930 | + def __init__(self, *args): |
931 | + super().__init__(*args) |
932 | + |
933 | + self.framework.observe(self.on.start, self.configure_pod) |
934 | + self.framework.observe(self.on.config_changed, self.configure_pod) |
935 | + self.framework.observe(self.on.leader_elected, self.configure_pod) |
936 | + self.framework.observe(self.on.upgrade_charm, self.configure_pod) |
937 | + |
938 | + self._stored.set_default(things=[]) |
939 | + |
940 | + def _check_juju_config(self) -> None: |
941 | + """Check if all the required Juju config options are set |
942 | + |
943 | + :raises GunicornK8sCharmJujuConfigError: if a required config is not set |
944 | + """ |
945 | + errors = [] |
946 | + for required in REQUIRED_JUJU_CONFIG: |
947 | + if required not in self.model.config or not self.model.config[required]: |
948 | + logger.error("Required Juju config not set : %s", required) |
949 | + errors.append(required) |
950 | + if errors: |
951 | + raise GunicornK8sCharmJujuConfigError( |
952 | + "Required Juju config not set : {0}".format(", ".join(sorted(errors))) |
953 | + ) |
954 | + |
955 | + def _make_k8s_ingress(self) -> list: |
956 | + """Return an ingress that you can use in k8s_resources |
957 | + """ |
958 | + |
959 | + ingress = { |
960 | + "name": "{}-ingress".format(self.app.name), |
961 | + "spec": { |
962 | + "rules": [ |
963 | + { |
964 | + "host": "example.com", |
965 | + "http": { |
966 | + "paths": [{"path": "/", "backend": {"serviceName": self.app.name, "servicePort": 80},}] |
967 | + }, |
968 | + } |
969 | + ] |
970 | + }, |
971 | + "annotations": {'nginx.ingress.kubernetes.io/ssl-redirect': 'false',}, |
972 | + } |
973 | + |
974 | + return [ingress] |
975 | + |
976 | + def _make_pod_config(self) -> dict: |
977 | + """Return an envConfig with some core configuration. |
978 | + |
979 | + :returns: A dictionary used for envConfig in podspec |
980 | + :rtype: dict |
981 | + """ |
982 | + pod_config = {} |
983 | + |
984 | + return pod_config |
985 | + |
986 | + def _make_pod_spec(self) -> dict: |
987 | + """Return a pod spec with some core configuration.""" |
988 | + |
989 | + config = self.model.config |
990 | + image_details = { |
991 | + 'imagePath': config['image_path'], |
992 | + } |
993 | + if config.get('image_username', None): |
994 | + image_details.update({'username': config['image_username'], 'password': config['image_password']}) |
995 | + pod_config = self._make_pod_config() |
996 | + |
997 | + return { |
998 | + 'version': 3, # otherwise resources are ignored |
999 | + 'containers': [ |
1000 | + { |
1001 | + 'name': self.app.name, |
1002 | + 'imageDetails': image_details, |
1003 | + # TODO: debatable. The idea is that if you want to force an update with the same image name, you |
1004 | + # don't need to empty kubelet cache on each node to have the right version. |
1005 | + # This implies a performance drop upon start. |
1006 | + 'imagePullPolicy': 'Always', |
1007 | + 'ports': [{'containerPort': 80, 'protocol': 'TCP'}], |
1008 | + 'envConfig': pod_config, |
1009 | + 'kubernetes': {'readinessProbe': {'httpGet': {'path': '/', 'port': 80}},}, |
1010 | + } |
1011 | + ], |
1012 | + } |
1013 | + |
1014 | + def configure_pod(self, event: ops.framework.EventBase) -> None: |
1015 | + """Assemble the pod spec and apply it, if possible. |
1016 | + |
1017 | + :param ops.framework.EventBase event: Event that triggered the method. |
1018 | + """ |
1019 | + |
1020 | + if not self.unit.is_leader(): |
1021 | + self.unit.status = ActiveStatus() |
1022 | + return |
1023 | + |
1024 | + try: |
1025 | + self._check_juju_config() |
1026 | + except GunicornK8sCharmJujuConfigError as e: |
1027 | + self.unit.status = BlockedStatus(str(e)) |
1028 | + return |
1029 | + |
1030 | + self.unit.status = MaintenanceStatus('Assembling pod spec') |
1031 | + pod_spec = self._make_pod_spec() |
1032 | + |
1033 | + resources = pod_spec.get('kubernetesResources', {}) |
1034 | + resources['ingressResources'] = self._make_k8s_ingress() |
1035 | + |
1036 | + self.unit.status = MaintenanceStatus('Setting pod spec') |
1037 | + self.model.pod.set_spec(pod_spec, k8s_resources={'kubernetesResources': resources}) |
1038 | + self.unit.status = ActiveStatus() |
1039 | + |
1040 | + |
1041 | +if __name__ == "__main__": |
1042 | + main(GunicornK8sCharm, use_juju_for_storage=True) |
1043 | diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt |
1044 | new file mode 100644 |
1045 | index 0000000..7466bfe |
1046 | --- /dev/null |
1047 | +++ b/tests/unit/requirements.txt |
1048 | @@ -0,0 +1,4 @@ |
1049 | +PyYAML |
1050 | +pytest |
1051 | +pytest-cov |
1052 | +pytest-subtests |
1053 | diff --git a/tests/unit/scenario.py b/tests/unit/scenario.py |
1054 | new file mode 100644 |
1055 | index 0000000..1dbf7ff |
1056 | --- /dev/null |
1057 | +++ b/tests/unit/scenario.py |
1058 | @@ -0,0 +1,98 @@ |
1059 | +#!/usr/bin/env python3 |
1060 | +"""Define tests scenarios.""" |
1061 | + |
1062 | +import logging |
1063 | +import os |
1064 | +import yaml |
1065 | + |
1066 | +from pathlib import Path |
1067 | + |
1068 | + |
1069 | +logger = logging.getLogger(__name__) |
1070 | + |
1071 | + |
1072 | +def get_juju_config() -> list: |
1073 | + """Return the list of juju settings as defined in config.yaml.""" |
1074 | + |
1075 | + dir_path = os.path.dirname(os.path.realpath(__file__)) |
1076 | + config_yaml = Path(dir_path, '..', '..', 'config.yaml') |
1077 | + with open(config_yaml, 'r') as config: |
1078 | + loaded_config = yaml.safe_load(config.read()) |
1079 | + |
1080 | + return list(loaded_config['options'].keys()) |
1081 | + |
1082 | + |
1083 | +# List of all juju settings. Used to clear them between tests |
1084 | +JUJU_CONFIG = get_juju_config() |
1085 | + |
1086 | +TEST_JUJU_CONFIG = { |
1087 | + 'missing_image_path': { |
1088 | + 'config': {}, |
1089 | + 'logger': ["ERROR:charm:Required Juju config not set : image_path"], |
1090 | + 'expected': 'Required Juju config not set : image_path', |
1091 | + }, |
1092 | + 'good_config': {'config': {'image_path': 'my_gunicorn_app:devel'}, 'logger': [], 'expected': False,}, |
1093 | +} |
1094 | + |
1095 | +TEST_CONFIGURE_POD = { |
1096 | + 'bad_config': {'config': {}, 'expected': 'Required Juju config not set : image_path',}, |
1097 | + 'good_config': {'config': {'image_path': 'my_gunicorn_app:devel'}, 'expected': False,}, |
1098 | +} |
1099 | + |
1100 | +TEST_MAKE_POD_SPEC = { |
1101 | + 'basic': { |
1102 | + 'config': {'image_path': 'my_gunicorn_app:devel',}, |
1103 | + 'pod_spec': { |
1104 | + 'version': 3, # otherwise resources are ignored |
1105 | + 'containers': [ |
1106 | + { |
1107 | + 'name': 'gunicorn', |
1108 | + 'imageDetails': {'imagePath': 'my_gunicorn_app:devel',}, |
1109 | + 'imagePullPolicy': 'Always', |
1110 | + 'ports': [{'containerPort': 80, 'protocol': 'TCP'}], |
1111 | + 'envConfig': {}, |
1112 | + 'kubernetes': {'readinessProbe': {'httpGet': {'path': '/', 'port': 80}}}, |
1113 | + } |
1114 | + ], |
1115 | + }, |
1116 | + }, |
1117 | + 'private_registry': { |
1118 | + 'config': {'image_path': 'my_gunicorn_app:devel', 'image_username': 'foo', 'image_password': 'bar',}, |
1119 | + 'pod_spec': { |
1120 | + 'version': 3, # otherwise resources are ignored |
1121 | + 'containers': [ |
1122 | + { |
1123 | + 'name': 'gunicorn', |
1124 | + 'imageDetails': {'imagePath': 'my_gunicorn_app:devel', 'username': 'foo', 'password': 'bar',}, |
1125 | + 'imagePullPolicy': 'Always', |
1126 | + 'ports': [{'containerPort': 80, 'protocol': 'TCP'}], |
1127 | + 'envConfig': {}, |
1128 | + 'kubernetes': {'readinessProbe': {'httpGet': {'path': '/', 'port': 80}}}, |
1129 | + } |
1130 | + ], |
1131 | + }, |
1132 | + }, |
1133 | +} |
1134 | + |
1135 | + |
1136 | +TEST_MAKE_K8S_INGRESS = { |
1137 | + 'basic': { |
1138 | + 'config': {'image_path': 'my_gunicorn_app:devel',}, |
1139 | + 'expected': [ |
1140 | + { |
1141 | + 'name': 'gunicorn-ingress', |
1142 | + 'spec': { |
1143 | + 'rules': [ |
1144 | + { |
1145 | + 'host': 'example.com', |
1146 | + 'http': { |
1147 | + 'paths': [{'path': '/', 'backend': {'serviceName': 'gunicorn', 'servicePort': 80},},], |
1148 | + }, |
1149 | + }, |
1150 | + ], |
1151 | + }, |
1152 | + 'annotations': {'nginx.ingress.kubernetes.io/ssl-redirect': 'false',}, |
1153 | + }, |
1154 | + ], |
1155 | + }, |
1156 | +} |
1157 | diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py |
1158 | new file mode 100755 |
1159 | index 0000000..3b68e10 |
1160 | --- /dev/null |
1161 | +++ b/tests/unit/test_charm.py |
1162 | @@ -0,0 +1,100 @@ |
1163 | +#!/usr/bin/env python3 |
1164 | + |
1165 | +"""Test for the gunicorn charm.""" |
1166 | + |
1167 | +import unittest |
1168 | + |
1169 | +from unittest.mock import MagicMock |
1170 | + |
1171 | +from charm import ( |
1172 | + GunicornK8sCharm, |
1173 | + GunicornK8sCharmJujuConfigError, |
1174 | +) |
1175 | + |
1176 | +from ops import testing |
1177 | +from ops.model import ( |
1178 | + ActiveStatus, |
1179 | + BlockedStatus, |
1180 | +) |
1181 | + |
1182 | +from scenario import ( |
1183 | + JUJU_CONFIG, |
1184 | + TEST_JUJU_CONFIG, |
1185 | + TEST_CONFIGURE_POD, |
1186 | + TEST_MAKE_POD_SPEC, |
1187 | + TEST_MAKE_K8S_INGRESS, |
1188 | +) |
1189 | + |
1190 | + |
1191 | +class TestGunicornK8sCharm(unittest.TestCase): |
1192 | + |
1193 | + maxDiff = None # Full diff when there is an error |
1194 | + |
1195 | + def setUp(self): |
1196 | + """Setup the harness object.""" |
1197 | + self.harness = testing.Harness(GunicornK8sCharm) |
1198 | + self.harness.begin() |
1199 | + |
1200 | + def tearDown(self): |
1201 | + """Cleanup the harness.""" |
1202 | + self.harness.cleanup() |
1203 | + |
1204 | + def test_check_juju_config(self): |
1205 | + """Check the required juju settings.""" |
1206 | + for scenario, values in TEST_JUJU_CONFIG.items(): |
1207 | + with self.subTest(scenario=scenario): |
1208 | + self.harness.update_config(values['config']) |
1209 | + if values['expected']: |
1210 | + with self.assertLogs(level='ERROR') as logger: |
1211 | + with self.assertRaises(GunicornK8sCharmJujuConfigError) as exc: |
1212 | + self.harness.charm._check_juju_config() |
1213 | + self.assertEqual(sorted(logger.output), sorted(values['logger'])) |
1214 | + self.assertEqual(str(exc.exception), values['expected']) |
1215 | + else: |
1216 | + self.assertEqual(self.harness.charm._check_juju_config(), None) |
1217 | + # You need to clean the config after each run |
1218 | + # See https://github.com/canonical/operator/blob/master/ops/testing.py#L415 |
1219 | + # The second argument is the list of key to reset |
1220 | + self.harness.update_config({}, JUJU_CONFIG) |
1221 | + |
1222 | + def test_configure_pod(self): |
1223 | + """Test the pod configuration.""" |
1224 | + mock_event = MagicMock() |
1225 | + |
1226 | + self.harness.set_leader(False) |
1227 | + self.harness.charm.unit.status = BlockedStatus("Testing") |
1228 | + self.harness.charm.configure_pod(mock_event) |
1229 | + self.assertEqual(self.harness.charm.unit.status, ActiveStatus()) |
1230 | + self.harness.update_config({}, JUJU_CONFIG) # You need to clean the config after each run |
1231 | + |
1232 | + for scenario, values in TEST_CONFIGURE_POD.items(): |
1233 | + with self.subTest(scenario=scenario): |
1234 | + self.harness.update_config(values['config']) |
1235 | + self.harness.set_leader(True) |
1236 | + self.harness.charm.configure_pod(mock_event) |
1237 | + if values['expected']: |
1238 | + self.assertEqual(self.harness.charm.unit.status, BlockedStatus(values['expected'])) |
1239 | + else: |
1240 | + self.assertEqual(self.harness.charm.unit.status, ActiveStatus()) |
1241 | + |
1242 | + self.harness.update_config({}, JUJU_CONFIG) # You need to clean the config after each run |
1243 | + |
1244 | + def test_make_pod_spec(self): |
1245 | + """Check the crafting of the pod spec.""" |
1246 | + for scenario, values in TEST_MAKE_POD_SPEC.items(): |
1247 | + with self.subTest(scenario=scenario): |
1248 | + self.harness.update_config(values['config']) |
1249 | + self.assertEqual(self.harness.charm._make_pod_spec(), values['pod_spec']) |
1250 | + self.harness.update_config({}, JUJU_CONFIG) # You need to clean the config after each run |
1251 | + |
1252 | + def test_make_k8s_ingress(self): |
1253 | + """Check the crafting of the ingress part of the pod spec.""" |
1254 | + for scenario, values in TEST_MAKE_K8S_INGRESS.items(): |
1255 | + with self.subTest(scenario=scenario): |
1256 | + self.harness.update_config(values['config']) |
1257 | + self.assertEqual(self.harness.charm._make_k8s_ingress(), values['expected']) |
1258 | + self.harness.update_config({}, JUJU_CONFIG) # You need to clean the config after each run |
1259 | + |
1260 | + |
1261 | +if __name__ == '__main__': |
1262 | + unittest.main() |
1263 | diff --git a/tox.ini b/tox.ini |
1264 | new file mode 100644 |
1265 | index 0000000..665fad6 |
1266 | --- /dev/null |
1267 | +++ b/tox.ini |
1268 | @@ -0,0 +1,49 @@ |
1269 | +[tox] |
1270 | +skipsdist=True |
1271 | +envlist = unit, functional |
1272 | +skip_missing_interpreters = True |
1273 | + |
1274 | +[testenv] |
1275 | +basepython = python3 |
1276 | +setenv = |
1277 | + PYTHONPATH = {toxinidir}/src:{toxinidir}/build/lib:{toxinidir}/build/venv |
1278 | + |
1279 | +[testenv:unit] |
1280 | +commands = |
1281 | + pytest --ignore mod --ignore {toxinidir}/tests/functional \ |
1282 | + {posargs:-v --cov=src --cov-report=term-missing --cov-branch} |
1283 | +deps = -r{toxinidir}/tests/unit/requirements.txt |
1284 | + -r{toxinidir}/requirements.txt |
1285 | +setenv = |
1286 | + PYTHONPATH={toxinidir}/src:{toxinidir}/build/lib:{toxinidir}/build/venv |
1287 | + TZ=UTC |
1288 | + |
1289 | +[testenv:functional] |
1290 | +passenv = |
1291 | + HOME |
1292 | + JUJU_REPOSITORY |
1293 | + PATH |
1294 | +commands = |
1295 | + pytest -v --ignore mod --ignore {toxinidir}/tests/unit {posargs} |
1296 | +deps = -r{toxinidir}/tests/functional/requirements.txt |
1297 | + -r{toxinidir}/requirements.txt |
1298 | + |
1299 | +[testenv:black] |
1300 | +commands = black --skip-string-normalization --line-length=120 src/ tests/ |
1301 | +deps = black |
1302 | + |
1303 | +[testenv:lint] |
1304 | +commands = flake8 src/ tests/ |
1305 | +# Pin flake8 to 3.7.9 to match focal |
1306 | +deps = |
1307 | + flake8==3.7.9 |
1308 | + |
1309 | +[flake8] |
1310 | +exclude = |
1311 | + .git, |
1312 | + __pycache__, |
1313 | + .tox, |
1314 | +# Ignore E231 because using black creates errors with this |
1315 | +ignore = E231 |
1316 | +max-line-length = 120 |
1317 | +max-complexity = 10 |
This merge proposal is being monitored by mergebot. Change the status to Approved to merge.