Improve naming and fix static type checking

* Improve documentation
* Move dns -> server_admin
* Fix mypy config
* Add a representation to Cluster
* Remove type: ignore directives
* Rename dns -> assign_dns
* Use a clusters list instead of relying on Cluster.instances
* Update mypy to 0.700
* "Friendly Name" -> "Server Friendly Name"

Author: fionn

README.md

@@ -12,7 +12,7 @@ The application expects AWS API secrets as the environment variables `AWS_ACCESS
 
 Run with `./run.py` or `flask run` to serve the web interface in development mode on `localhost:5000` with Flask. To serve with `gunicorn` on `localhost:8000`, run the command in `Procfile`. Simulate a deployment with `heroku local`.
 
-Some toy data is created in `dns.create_instances`.
+Some toy data is created by `dns.create_instances`.
 
 ### Deploy
 

app/dns/__init__.py renamed to app/server_admin/__init__.py

@@ -5,7 +5,7 @@
 from typing import List
 
 import boto
-import route53 # type: ignore
+import route53
 
 AWS_ACCESS_ID = os.environ["AWS_ACCESS_ID"]
 AWS_ACCESS_SECRET = os.environ["AWS_ACCESS_SECRET"]
@@ -24,6 +24,9 @@ def __init__(self, cluster_id: int) -> None:
         self.cluster_name = self._name()
         self.subdomain = self._subdomain()
 
+    def __repr__(self) -> str:
+        return f"<{type(self).__name__}(cluster_id={self.cluster_id})>"
+
     def _name(self) -> str:
         name_dict = {1: "Los Angeles",
                      2: "New York",
@@ -72,8 +75,7 @@ def add_to_rotation(self) -> None:
         conn = boto.connect_route53(aws_access_key_id=AWS_ACCESS_ID,
                                     aws_secret_access_key=AWS_ACCESS_SECRET)
 
-        changes = boto.route53.record.ResourceRecordSets(conn, # type: ignore
-                                                         self.zone.id)
+        changes = boto.route53.record.ResourceRecordSets(conn, self.zone.id)
         change = changes.add_change("UPSERT", fqdn, "A")
 
         for ip_address in set(ips):
@@ -99,8 +101,7 @@ def remove_from_rotation(self) -> None:
         conn = boto.connect_route53(aws_access_key_id=AWS_ACCESS_ID,
                                     aws_secret_access_key=AWS_ACCESS_SECRET)
 
-        changes = boto.route53.record.ResourceRecordSets(conn, # type: ignore
-                                                         self.zone.id)
+        changes = boto.route53.record.ResourceRecordSets(conn, self.zone.id)
 
         # This should be simple, but seemingly the API complains unless
         # it's updated in this arduous fashion.
@@ -115,7 +116,7 @@ def remove_from_rotation(self) -> None:
 
         changes.commit()
 
-def dns() -> list:
+def assign_dns() -> list:
     """Grabs all A records for the hosted zone
     and assigns them to class variables"""
     print("Fetching DNS A records... ", end="", flush=True)
@@ -138,10 +139,9 @@ def dns() -> list:
 
 def create_instances() -> None:
     """Instantiates clusters and their servers"""
+    clusters = []
     for i in range(1, Cluster.n + 1):
-        Cluster(i)
-
-    clusters = Cluster.instances
+        clusters.append(Cluster(i))
 
     la1 = clusters[0].create_server("la1")
     ny1 = clusters[1].create_server("ny1")
@@ -166,14 +166,14 @@ def update_server_dns(dns_records: list) -> None:
                 server.dns = record.name
 
 def print_servers() -> None:
-    """ASCII analogy of the server UI."""
+    """ASCII analogy of the server UI"""
     print("\n\033[1mID\t Name\t Cluster\t DNS\t\t\t IP\033[0m")
     for server in Server.instances:
         print(server.server_id, "\t", server.friendly_name, "\t",
               server.cluster_name, "\t", server.dns, "\t", server.ip_string)
 
 def print_dns(dns_records: list) -> None:
-    """ASCII analogy of the DNS UI."""
+    """ASCII analogy of the DNS UI"""
     print("\n\033[1mDomain\t\t\t\t\t IP(s)\t\t Server(s)\t Cluster\033[0m")
     for record in dns_records:
         matching_servers = []
@@ -187,7 +187,7 @@ def print_dns(dns_records: list) -> None:
 def main() -> None:
     """Entry point"""
     create_instances()
-    records = dns()
+    records = assign_dns()
     update_server_dns(records)
 
     print_servers()

app/dns/dns.py renamed to app/server_admin/dns.py

@@ -32,7 +32,7 @@ <h1>Servers</h1>
         <thead>
             <tr>
                 <th>ID</th>
-                <th>Friendly Name&nbsp;&#x25BC;</th>
+                <th>Server Friendly Name&nbsp;&#x25BC;</th>
                 <th>Cluster</th>
                 <th>DNS</th>
                 <th>Rotation</th>

app/templates/servers.html

@@ -2,7 +2,9 @@
 
 import flask
 import werkzeug
-from .dns.dns import Cluster, Server, dns, update_server_dns, create_instances
+
+from .server_admin.dns import Cluster, Server, assign_dns, update_server_dns, \
+                              create_instances
 
 BP = flask.Blueprint("views", __name__, url_prefix="/")
 
@@ -26,20 +28,21 @@ def index() -> flask.signals.template_rendered:
 
 @APP.route("/servers")
 def servers_ui() -> flask.signals.template_rendered:
-    """renders the server UI"""
-    update_server_dns(dns())
+    """Renders the server UI"""
+    update_server_dns(assign_dns())
     servers = Server.instances
     return flask.render_template("servers.html", title="Servers", servers=servers)
 
 @APP.route("/dns")
 def dns_ui() -> flask.signals.template_rendered:
-    """renders the DNS UI"""
+    """Renders the DNS UI"""
     return flask.render_template("dns.html", title="DNS", zone=Cluster.zone,
-                                 servers=Server.instances, dns_records=dns())
+                                 servers=Server.instances,
+                                 dns_records=assign_dns())
 
 @APP.route("/rotate", methods=["GET", "POST"])
 def rotate() -> werkzeug.wrappers.Response:
-    """ Moves the server(s) into / out of DNS rotation """
+    """Moves the server(s) into / out of DNS rotation"""
     if flask.request.method == "POST":
         action = flask.request.form.get("action")
         server_id = int(flask.request.form.get("server")) # type: ignore
@@ -63,9 +66,9 @@ def rotate() -> werkzeug.wrappers.Response:
     return flask.redirect("/servers")
 
 def main() -> None:
-    """main view function"""
+    """Main view function"""
     create_instances()
-    records = dns()
+    records = assign_dns()
     update_server_dns(records)
     #print_servers()
     #print_dns(records)

app/views.py

@@ -3,9 +3,13 @@ check_untyped_defs = True
 warn_redundant_casts = True
 disallow_untyped_defs = True
 warn_unused_ignores = True
+strict_equality = True
 
 [mypy-route53]
 ignore_missing_imports = True
+follow_imports=skip
+follow_imports_for_stubs=True
 
-[mypy-boto]
-ignore_missing_imports = True
+[mypy-boto.*]
+follow_imports=skip
+follow_imports_for_stubs=True

.mypy.ini renamed to mypy.ini

@@ -1,3 +1,3 @@
-mypy >= 0.670
+mypy >= 0.700
 pylint >= 2.3.1
 python-dotenv >= 0.10.1