1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3 <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
4 <title>ConfigurableNginxContainer xref</title>
5 <link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
8 <div id="overview"><a href="../../../../testapidocs/de/juplo/httpresources/ConfigurableNginxContainer.html">View Javadoc</a></div><pre>
9 <a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> de.juplo.httpresources;
10 <a class="jxr_linenumber" name="L2" href="#L2">2</a>
11 <a class="jxr_linenumber" name="L3" href="#L3">3</a>
12 <a class="jxr_linenumber" name="L4" href="#L4">4</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files;
13 <a class="jxr_linenumber" name="L5" href="#L5">5</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path;
14 <a class="jxr_linenumber" name="L6" href="#L6">6</a> <strong class="jxr_keyword">import</strong> java.nio.file.Paths;
15 <a class="jxr_linenumber" name="L7" href="#L7">7</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap;
16 <a class="jxr_linenumber" name="L8" href="#L8">8</a> <strong class="jxr_keyword">import</strong> java.util.LinkedList;
17 <a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> java.util.List;
18 <a class="jxr_linenumber" name="L10" href="#L10">10</a> <strong class="jxr_keyword">import</strong> java.util.Map;
19 <a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
20 <a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
21 <a class="jxr_linenumber" name="L13" href="#L13">13</a> <strong class="jxr_keyword">import</strong> org.testcontainers.containers.BindMode;
22 <a class="jxr_linenumber" name="L14" href="#L14">14</a> <strong class="jxr_keyword">import</strong> org.testcontainers.containers.NginxContainer;
23 <a class="jxr_linenumber" name="L15" href="#L15">15</a>
24 <a class="jxr_linenumber" name="L16" href="#L16">16</a>
25 <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_javadoccomment">/**</em>
26 <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_javadoccomment"> * A configurable subclass of the {@link NginxContainer}.</em>
27 <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment"> * @author Kai Moritz</em>
28 <a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_javadoccomment"> */</em>
29 <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ConfigurableNginxContainer" href="../../../de/juplo/httpresources/ConfigurableNginxContainer.html#ConfigurableNginxContainer">ConfigurableNginxContainer</a> <strong class="jxr_keyword">extends</strong> NginxContainer
30 <a class="jxr_linenumber" name="L22" href="#L22">22</a> {
31 <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> Logger LOG =
32 <a class="jxr_linenumber" name="L24" href="#L24">24</a> LoggerFactory.getLogger(ConfigurableNginxContainer.<strong class="jxr_keyword">class</strong>);
33 <a class="jxr_linenumber" name="L25" href="#L25">25</a>
34 <a class="jxr_linenumber" name="L26" href="#L26">26</a>
35 <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> DEFAULT_NGINX_PORT = 80;
36 <a class="jxr_linenumber" name="L28" href="#L28">28</a>
37 <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, String> directives;
38 <a class="jxr_linenumber" name="L30" href="#L30">30</a>
39 <a class="jxr_linenumber" name="L31" href="#L31">31</a>
40 <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em>
41 <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Creates an instance with a default-configuration, that matches the</em>
42 <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * static configuration of the base-class {@link NginxContainer}</em>
43 <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em>
44 <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <a name="ConfigurableNginxContainer" href="../../../de/juplo/httpresources/ConfigurableNginxContainer.html#ConfigurableNginxContainer">ConfigurableNginxContainer</a>()
45 <a class="jxr_linenumber" name="L37" href="#L37">37</a> {
46 <a class="jxr_linenumber" name="L38" href="#L38">38</a> directives = <strong class="jxr_keyword">new</strong> LinkedHashMap<>();
47 <a class="jxr_linenumber" name="L39" href="#L39">39</a> directives.put(<span class="jxr_string">"daemon"</span>, <span class="jxr_string">"off"</span>);
48 <a class="jxr_linenumber" name="L40" href="#L40">40</a> }
49 <a class="jxr_linenumber" name="L41" href="#L41">41</a>
50 <a class="jxr_linenumber" name="L42" href="#L42">42</a>
51 <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
52 <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Adds a global directive to the configuration-map.</em>
53 <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p></em>
54 <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * This method can only be used to add <em>global</em> directives.</em>
55 <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Global directives are all directives, that are marked with the context</em>
56 <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * <code>Main</code> in the {@link <a href="http://nginx.org/en/docs/ngx_core_module.html" target="alexandria_uri">http://nginx.org/en/docs/ngx_core_module.html</a></em>
57 <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Nginx-documentation}, for example <code>daemon</code>, <code>user</code></em>
58 <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * and <code>env</code>.</em>
59 <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <p></em>
60 <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * If you need to modify contexts, like <code>server</code> or</em>
61 <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <code>http</code>, you have to</em>
62 <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * {@link #withConfiguration(String) pass in a complete configuration}.</em>
63 <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param key The key of the directive</em>
64 <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @param value The value of the directive (the <code>;</code> is added automatically)</em>
65 <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @return <code>this</code> instance, to enable a fluid API.</em>
66 <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
67 <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <a name="ConfigurableNginxContainer" href="../../../de/juplo/httpresources/ConfigurableNginxContainer.html#ConfigurableNginxContainer">ConfigurableNginxContainer</a> withGlobalDirective(String key, String value)
68 <a class="jxr_linenumber" name="L60" href="#L60">60</a> {
69 <a class="jxr_linenumber" name="L61" href="#L61">61</a> directives.put(key, value);
70 <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
71 <a class="jxr_linenumber" name="L63" href="#L63">63</a> }
72 <a class="jxr_linenumber" name="L64" href="#L64">64</a>
73 <a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> Map<String, String> getGlobalDirectives()
74 <a class="jxr_linenumber" name="L66" href="#L66">66</a> {
75 <a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong> directives;
76 <a class="jxr_linenumber" name="L68" href="#L68">68</a> }
77 <a class="jxr_linenumber" name="L69" href="#L69">69</a>
78 <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <a name="ConfigurableNginxContainer" href="../../../de/juplo/httpresources/ConfigurableNginxContainer.html#ConfigurableNginxContainer">ConfigurableNginxContainer</a> withConfiguration(String path)
79 <a class="jxr_linenumber" name="L71" href="#L71">71</a> {
80 <a class="jxr_linenumber" name="L72" href="#L72">72</a> Path config = Paths.get(path);
81 <a class="jxr_linenumber" name="L73" href="#L73">73</a>
82 <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">if</strong> (Files.isRegularFile(config))
83 <a class="jxr_linenumber" name="L75" href="#L75">75</a> {
84 <a class="jxr_linenumber" name="L76" href="#L76">76</a> LOG.info(<span class="jxr_string">"Binding file {} as /etc/nginx/nginx.conf"</span>, config.toAbsolutePath());
85 <a class="jxr_linenumber" name="L77" href="#L77">77</a> addFileSystemBind(path, <span class="jxr_string">"/etc/nginx/nginx.conf"</span>, BindMode.READ_ONLY);
86 <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
87 <a class="jxr_linenumber" name="L79" href="#L79">79</a> }
88 <a class="jxr_linenumber" name="L80" href="#L80">80</a>
89 <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (Files.isDirectory(config))
90 <a class="jxr_linenumber" name="L82" href="#L82">82</a> {
91 <a class="jxr_linenumber" name="L83" href="#L83">83</a> LOG.info(<span class="jxr_string">"Binding directory {} as /etc/nginx/"</span>, config.toAbsolutePath());
92 <a class="jxr_linenumber" name="L84" href="#L84">84</a> addFileSystemBind(path, <span class="jxr_string">"/etc/nginx/nginx.conf"</span>, BindMode.READ_ONLY);
93 <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
94 <a class="jxr_linenumber" name="L86" href="#L86">86</a> }
95 <a class="jxr_linenumber" name="L87" href="#L87">87</a>
96 <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
97 <a class="jxr_linenumber" name="L89" href="#L89">89</a> config.toAbsolutePath() +
98 <a class="jxr_linenumber" name="L90" href="#L90">90</a> <span class="jxr_string">" has to represent either a directory, or a regular file!"</span>);
99 <a class="jxr_linenumber" name="L91" href="#L91">91</a> }
100 <a class="jxr_linenumber" name="L92" href="#L92">92</a>
101 <a class="jxr_linenumber" name="L93" href="#L93">93</a> @Override
102 <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configure()
103 <a class="jxr_linenumber" name="L95" href="#L95">95</a> {
104 <a class="jxr_linenumber" name="L96" href="#L96">96</a> addExposedPort(DEFAULT_NGINX_PORT);
105 <a class="jxr_linenumber" name="L97" href="#L97">97</a> List<String> commands = <strong class="jxr_keyword">new</strong> LinkedList<>();
106 <a class="jxr_linenumber" name="L98" href="#L98">98</a> commands.add(<span class="jxr_string">"nginx"</span>);
107 <a class="jxr_linenumber" name="L99" href="#L99">99</a> directives.entrySet().forEach((directive) ->
108 <a class="jxr_linenumber" name="L100" href="#L100">100</a> {
109 <a class="jxr_linenumber" name="L101" href="#L101">101</a> commands.add(<span class="jxr_string">"-g"</span>);
110 <a class="jxr_linenumber" name="L102" href="#L102">102</a> commands.add(directive.getKey() + <span class="jxr_string">" "</span> + directive.getValue() + <span class="jxr_string">";"</span>);
111 <a class="jxr_linenumber" name="L103" href="#L103">103</a> });
112 <a class="jxr_linenumber" name="L104" href="#L104">104</a> LOG.info(<span class="jxr_string">"CMD: {}"</span>, commands);
113 <a class="jxr_linenumber" name="L105" href="#L105">105</a> setCommand(commands.toArray(<strong class="jxr_keyword">new</strong> String[commands.size()]));
114 <a class="jxr_linenumber" name="L106" href="#L106">106</a> }
115 <a class="jxr_linenumber" name="L107" href="#L107">107</a> }
118 <div id="footer">Copyright © 2020–2021 <a href="https://juplo.de">juplo</a>. All rights reserved.</div>
projects / website / blob