Remove blind wait times and use boto3 waiter

Remove hard coding and move to Settings object
Remove security group deletion dependency
Raise Warnings for failed waiters
Set timeout for SSH connection
Use gitverse for release notes
Update requirements

Author: dormant-user

.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 repos:
   -
-    repo: https://gitlab.com/pycqa/flake8
-    rev: '3.9.2'
+    repo: https://github.com/PyCQA/flake8
+    rev: '6.1.0'
     hooks:
       -
         id: flake8
         additional_dependencies:
           - flake8-docstrings
           - flake8-sfs
-        args: [--max-line-length=120, --extend-ignore=SFS3 D107 SFS301 D100 D104 D401]
+        args: [--max-line-length=120, --extend-ignore=SFS3 D107 SFS301 D100 D104 D401 SFS101 SFS201]
 
   -
-    repo: https://github.com/pre-commit/mirrors-isort
-    rev: 'v5.8.0'
+    repo: https://github.com/PyCQA/isort
+    rev: '5.12.0'
     hooks:
       -
         id: isort

README.md

@@ -114,7 +114,7 @@ changelog reverse -f release_notes.rst -t 'Release Notes'
 
 **Requirement**
 ```shell
-pip install sphinx==5.1.1 pre-commit recommonmark
+pip install sphinx==5.1.1 pre-commit recommonmark gitverse
 ```
 
 **Usage**

docs/README.html

@@ -97,7 +97,7 @@ <h3>Certificate:<a class="headerlink" href="#certificate" title="Permalink to th
 <p>:warning:   Some web browsers might throw a warning and some might even block a self-signed certificate/private CA.</p>
 <p>To manually generate a self-signed cert:</p>
 <blockquote>
-<div><p><code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">req</span> <span class="pre">-newkey</span> <span class="pre">rsa:2048</span> <span class="pre">-new</span> <span class="pre">-nodes</span> <span class="pre">-x509</span> <span class="pre">-days</span> <span class="pre">3650</span> <span class="pre">-keyout</span> <span class="pre">~/.ssh/key.pem</span> <span class="pre">-out</span> <span class="pre">~/.ssh/cert.pem</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">req</span> <span class="pre">-newkey</span> <span class="pre">rsa:2048</span> <span class="pre">-sha256</span> <span class="pre">-nodes</span> <span class="pre">-keyout</span> <span class="pre">YOURPRIVATE.key</span> <span class="pre">-x509</span> <span class="pre">-days</span> <span class="pre">365</span> <span class="pre">-out</span> <span class="pre">YOURPUBLIC.pem</span> <span class="pre">-subj</span> <span class="pre">&quot;/C=US/ST=New</span> <span class="pre">York/L=Brooklyn/O=Example</span> <span class="pre">Brooklyn</span> <span class="pre">Company/CN=YOURDOMAIN.EXAMPLE&quot;</span></code></p>
 </div></blockquote>
 <p>[OR]</p>
 <p>Simply let <code class="docutils literal notranslate"><span class="pre">expose</span></code> create a self-signed SSL certificate and a private key.</p>
@@ -115,20 +115,15 @@ <h3>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </pre></div>
 </div>
 </section>
-<section id="start-tunneling">
-<h3>Start tunneling:<a class="headerlink" href="#start-tunneling" title="Permalink to this heading">¶</a></h3>
+<section id="tunneling">
+<h3>Tunneling:<a class="headerlink" href="#tunneling" title="Permalink to this heading">¶</a></h3>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">expose</span>
 
 <span class="n">tunnel</span> <span class="o">=</span> <span class="n">expose</span><span class="o">.</span><span class="n">Tunnel</span><span class="p">()</span>
+<span class="c1"># set &#39;purge&#39; flag to &#39;True&#39; to delete AWS resources if configuration fails</span>
 <span class="n">tunnel</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-</pre></div>
-</div>
-</section>
-<section id="stop-tunneling">
-<h3>Stop tunneling:<a class="headerlink" href="#stop-tunneling" title="Permalink to this heading">¶</a></h3>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">expose</span>
-
-<span class="n">tunnel</span> <span class="o">=</span> <span class="n">expose</span><span class="o">.</span><span class="n">Tunnel</span><span class="p">()</span>
+<span class="c1"># sleep or do something else</span>
+<span class="c1"># set &#39;partial&#39; flag to &#39;True&#39; to skip SG deletion</span>
 <span class="n">tunnel</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 </pre></div>
 </div>
@@ -161,7 +156,7 @@ <h2><a class="reference external" href="https://github.com/thevickypedia/expose/
 <h2>Linting<a class="headerlink" href="#linting" title="Permalink to this heading">¶</a></h2>
 <p><code class="docutils literal notranslate"><span class="pre">PreCommit</span></code> will ensure linting, and the doc creation are run on every commit.</p>
 <p><strong>Requirement</strong></p>
-<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="nv">sphinx</span><span class="o">==</span><span class="m">5</span>.1.1<span class="w"> </span>pre-commit<span class="w"> </span>recommonmark
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="nv">sphinx</span><span class="o">==</span><span class="m">5</span>.1.1<span class="w"> </span>pre-commit<span class="w"> </span>recommonmark<span class="w"> </span>gitverse
 </pre></div>
 </div>
 <p><strong>Usage</strong></p>
@@ -205,8 +200,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </li>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
 <li><a class="reference internal" href="#installation">Installation</a></li>
-<li><a class="reference internal" href="#start-tunneling">Start tunneling:</a></li>
-<li><a class="reference internal" href="#stop-tunneling">Stop tunneling:</a></li>
+<li><a class="reference internal" href="#tunneling">Tunneling:</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#coding-standards">Coding Standards</a></li>

docs/_sources/README.md.txt

@@ -55,7 +55,7 @@ Unfortunately not many SSL certificate providers give the liberty to download ke
 
 To manually generate a self-signed cert:
 
-> `openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout ~/.ssh/key.pem -out ~/.ssh/cert.pem`
+> `openssl req -newkey rsa:2048 -sha256 -nodes -keyout YOURPRIVATE.key -x509 -days 365 -out YOURPUBLIC.pem -subj "/C=US/ST=New York/L=Brooklyn/O=Example Brooklyn Company/CN=YOURDOMAIN.EXAMPLE"`
 
 [OR]
 
@@ -72,19 +72,15 @@ Simply let `expose` create a self-signed SSL certificate and a private key.
 python3 -m pip install expose-localhost
 ```
 
-###### Start tunneling:
+###### Tunneling:
 ```python
 import expose
 
 tunnel = expose.Tunnel()
+# set 'purge' flag to 'True' to delete AWS resources if configuration fails
 tunnel.start()
-```
-
-###### Stop tunneling:
-```python
-import expose
-
-tunnel = expose.Tunnel()
+# sleep or do something else
+# set 'partial' flag to 'True' to skip SG deletion
 tunnel.stop()
 ```
 
@@ -118,7 +114,7 @@ changelog reverse -f release_notes.rst -t 'Release Notes'
 
 **Requirement**
 ```shell
-pip install sphinx==5.1.1 pre-commit recommonmark
+pip install sphinx==5.1.1 pre-commit recommonmark gitverse
 ```
 
 **Usage**

docs/_static/pygments.css

@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */

docs/genindex.html

@@ -44,57 +44,43 @@ <h1 id="index">Index</h1>
  <a href="#_"><strong>_</strong></a>
  | <a href="#A"><strong>A</strong></a>
  | <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
+ | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#J"><strong>J</strong></a>
  | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#T"><strong>T</strong></a>
+ | <a href="#W"><strong>W</strong></a>
 
 </div>
 <h2 id="_">_</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#expose.main.Tunnel._authorize_security_group">_authorize_security_group() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._configure_vm">_configure_vm() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._create_ec2_instance">_create_ec2_instance() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._create_key_pair">_create_key_pair() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._create_security_group">_create_security_group() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._delete_key_pair">_delete_key_pair() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._delete_security_group">_delete_security_group() (expose.main.Tunnel method)</a>
-</li>
-  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.cert._generate_serial_hash">_generate_serial_hash() (in module expose.helpers.cert)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._get_image_id">_get_image_id() (expose.main.Tunnel method)</a>
 </li>
       <li><a href="index.html#expose.helpers.cert._get_serial">_get_serial() (in module expose.helpers.cert)</a>
 </li>
-      <li><a href="index.html#expose.main.Tunnel._get_vpc_id">_get_vpc_id() (expose.main.Tunnel method)</a>
-</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.route_53._get_zone_id">_get_zone_id() (in module expose.helpers.route_53)</a>
 </li>
       <li><a href="index.html#expose.helpers.server.Server._handler">_handler() (expose.helpers.server.Server method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._instance_info">_instance_info() (expose.main.Tunnel method)</a>
-</li>
-      <li><a href="index.html#expose.main.Tunnel._terminate_ec2_instance">_terminate_ec2_instance() (expose.main.Tunnel method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.authorize_security_group">authorize_security_group() (expose.main.Tunnel method)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.defaults.AWSDefaults">AWSDefaults (class in expose.helpers.defaults)</a>
 </li>
@@ -105,6 +91,30 @@ <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.route_53.change_record_set">change_record_set() (in module expose.helpers.route_53)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.configure_vm">configure_vm() (expose.main.Tunnel method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.create_ec2_instance">create_ec2_instance() (expose.main.Tunnel method)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.create_key_pair">create_key_pair() (expose.main.Tunnel method)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.create_security_group">create_security_group() (expose.main.Tunnel method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.delete_key_pair">delete_key_pair() (expose.main.Tunnel method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.delete_security_group">delete_security_group() (expose.main.Tunnel method)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.disassociate_security_group">disassociate_security_group() (expose.main.Tunnel method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -166,10 +176,26 @@ <h2 id="E">E</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.helpers.auxiliary.flush_screen">flush_screen() (in module expose.helpers.auxiliary)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.cert.generate_cert">generate_cert() (in module expose.helpers.cert)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.get_config">get_config() (expose.main.Tunnel method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.get_image_id">get_image_id() (expose.main.Tunnel method)</a>
+</li>
+      <li><a href="index.html#expose.main.Tunnel.get_vpc_id">get_vpc_id() (expose.main.Tunnel method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -215,6 +241,14 @@ <h2 id="M">M</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.helpers.auxiliary.NotImplementedWarning">NotImplementedWarning</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -236,12 +270,14 @@ <h2 id="S">S</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#expose.helpers.server.Server">Server (class in expose.helpers.server)</a>
 </li>
-      <li><a href="index.html#expose.helpers.server.Server.server_write">server_write() (expose.helpers.server.Server method)</a>
+      <li><a href="index.html#expose.main.Tunnel.server_copy">server_copy() (expose.main.Tunnel method)</a>
 </li>
-      <li><a href="index.html#expose.main.Tunnel.start">start() (expose.main.Tunnel method)</a>
+      <li><a href="index.html#expose.helpers.server.Server.server_write">server_write() (expose.helpers.server.Server method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.main.Tunnel.start">start() (expose.main.Tunnel method)</a>
+</li>
       <li><a href="index.html#expose.main.Tunnel.stop">stop() (expose.main.Tunnel method)</a>
 </li>
       <li><a href="index.html#expose.helpers.defaults.AWSDefaults.SUPPORTED_ACTIONS">SUPPORTED_ACTIONS (expose.helpers.defaults.AWSDefaults attribute)</a>
@@ -254,15 +290,25 @@ <h2 id="S">S</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#expose.helpers.auxiliary.time_converter">time_converter() (in module expose.helpers.auxiliary)</a>
+      <li><a href="index.html#expose.main.Tunnel.terminate_ec2_instance">terminate_ec2_instance() (expose.main.Tunnel method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.helpers.auxiliary.time_converter">time_converter() (in module expose.helpers.auxiliary)</a>
+</li>
       <li><a href="index.html#expose.main.Tunnel">Tunnel (class in expose.main)</a>
 </li>
   </ul></td>
 </tr></table>
 
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#expose.helpers.auxiliary.write_screen">write_screen() (in module expose.helpers.auxiliary)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
             <div class="clearer"></div>