inno-devops-labs · FurryLord · Jan 31, 2024 · Jan 31, 2024 · Jan 31, 2024 · Jan 31, 2024
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+app.log
+__pycache__
diff --git a/README.md b/README.md
diff --git a/app_python/PYTHON.md b/app_python/PYTHON.md
@@ -0,0 +1,17 @@
+## Choice of framework
+
+
+I chose ``Flask`` for this project due to following reasons:
+ - It is well-suited for small projects:)
+ - It is easy to insert content into HTML templates using it.
+ - It has build-in development server for testing.
+
+## Best practices
+
+- Logging: use ``logging`` library for printing logs into ``app.log`` file
+- ``.gitignore``: use it to stash logs.
+- Error handling: add ``error.html`` template to render it in case of errors.
+- Code formatting: use ``Pylint`` for it.
+- Testing: wrote test for validating if rendered time is correct using ``unittest`` library.
+- Created ``requirements.txt`` file using <code>pip freeze > requirements.txt</code> command.
+- Store all HTML templates into separate folder ``templates``
diff --git a/app_python/README.md b/app_python/README.md
@@ -0,0 +1,29 @@
+## Description of application
+
+### 1. Purpose
+
+This simple app used to display current Moscow (UTC-3) time.
+
+### 2. Stack
+- Framework: ``flask``
+- Templates of pages: ``Django HTML``
+- Time calcualtion: ``datetime`` library
+- Testing: ``unittest`` library
+- Logging: ``logging`` library
+
+
+### 3. Structure
+
+- ``app.py`` performs routing at ``'/'`` and calculates Moscow time.
+- ``test_app.py`` performs unit test to validate the correctness of time.
+- ``app.log`` contains logs of application during its work.
+
+#### 3.1. Tempelates
+-  ``index.html`` is the main page where time is shown.
+-  ``error.html`` contains a message that error has occured.
+
+#### 3.2. Documentation
+- ``PYTHON.md`` describes the reasons of choosing ``flask`` and best practices applied to the project.
+- ``README.md`` describes the overall structure of project.
+
+
diff --git a/app_python/app.py b/app_python/app.py
@@ -0,0 +1,35 @@
+import datetime
+import logging
+from flask import Flask, render_template
+
+app = Flask(__name__)
+
+# Configure logging
+logging.basicConfig(filename='app.log', level=logging.INFO,
+                    format='%(asctime)s - %(levelname)s - %(message)s')
+
+
+@app.route('/')
+def display_time():
+    try:
+        # Correct the usage of datetime.utcnow()
+        moscow_time = datetime.datetime.utcnow() + datetime.timedelta(hours=3)
+        formatted_time = moscow_time.strftime("%Y-%m-%d %H:%M:%S")
+
+        # Log the current time
+        logging.info(f"Displayed Moscow time: {formatted_time}")
+
+        # Log a custom message
+        logging.info("Custom log message")
+
+        return render_template('index.html', time=formatted_time)
+    except Exception as e:
+        # Log any exceptions that occur
+        logging.error(f"An error occurred: {str(e)}")
+
+        # You can create an error template for users
+        return render_template('error.html')
+
+
+if __name__ == '__main__':
+    app.run()
diff --git a/app_python/requirements.txt b/app_python/requirements.txt
diff --git a/app_python/templates/error.html b/app_python/templates/error.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <title>Error - Lab 1</title>
+  </head>
+  <body>
+    <main>
+        <h1>An error occurred</h1>
+    </main>
+  </body>
+</html>
diff --git a/app_python/templates/index.html b/app_python/templates/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <title>lab 1</title>
+  </head>
+  <body>
+    <main>
+        <h1>Current time in Moscow: {{time}}</h1>  
+    </main>
+  </body>
+</html>
diff --git a/app_python/test_app.py b/app_python/test_app.py
@@ -0,0 +1,20 @@
+import unittest
+from app import app
+import datetime
+
+class FlaskAppTests(unittest.TestCase):
+
+    def setUp(self):
+        self.app = app.test_client()
+        self.app.testing = True
+
+    def test_moscow_time_calculation(self):
+        utc_now = datetime.datetime.utcnow()
+        expected_moscow_time = utc_now + datetime.timedelta(hours=3)
+        expected_time_str = expected_moscow_time.strftime("%Y-%m-%d %H:%M:%S")
+        response = self.app.get('/')
+        displayed_time_str = response.data.decode('utf-8').split(': ')[1].split('</h1>')[0].strip()
+        self.assertEqual(displayed_time_str, expected_time_str)
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/lab1.md b/lab1.md
diff --git a/lab10.md b/lab10.md