Merge pull request #75 from patrickmogul/main

v1.3.1 - Test Cases

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

requirements.txt

@@ -36,6 +36,7 @@ pycryptodome==3.16.0
 pyhmy==0.1.0
 PyJWT==2.6.0
 pyperclip==1.8.2
+pytest>=7.4.2
 python-dotenv==0.21.0
 requests>=2.28.1
 rlp==3.0.0

src/__init__.py

@@ -1,3 +0,0 @@
-from .library import load_var_file, ask_yes_no, set_var
-
-__all__ = ['load_var_file', 'ask_yes_no', 'set_var']

src/app.py

@@ -1,4 +1,5 @@
-import os, argparse
+import os
+import argparse
 from toolbox import (
     run_findora_menu,
     menu_install_findora,
@@ -9,25 +10,28 @@
     container_running,
     run_troubleshooting_process,
     parse_flags,
-    check_preflight_setup
+    check_preflight_setup,
 )
-from config import findora_env
+from shared import findora_env
+
 
 def main() -> None:
     # Intro w/ stars below
     loader_intro()
     print_stars()
-    
+
     # Load Vars / Set Network & Region
-    network, region = check_preflight_setup(findora_env.dotenv_file, findora_env.user_home_dir, findora_env.active_user_name)
-
+    network, region = check_preflight_setup(
+        findora_env.dotenv_file, findora_env.user_home_dir, findora_env.active_user_name
+    )
+
     # Can this user access docker?
     docker_check()
-    
+
     # Init parser for extra flags:
     parser = argparse.ArgumentParser(description="Findora Validator Toolbox - Help Menu")
     parse_flags(parser, region, network)
-    
+
     # If `fn` isn't installed, run full installer.
     if not os.path.exists("/usr/local/bin/fn"):
         # It does not, let's ask to install!

src/installer.py

@@ -1,5 +1,4 @@
 import subprocess
-from config import findora_env
 from shared import (
     create_directory_with_permissions,
     install_fn_app,
@@ -8,6 +7,7 @@
     load_server_data,
     start_local_validator,
     get_live_version,
+    findora_env
 )
 
 
@@ -36,7 +36,7 @@ def run_full_installer(network, region):
 
     # Make Directories & Set Permissions
     create_directory_with_permissions("/data/findora", USERNAME)
-    
+
     # Create backup directory
     subprocess.run(
         ["mkdir", "-p", f"/home/{USERNAME}/findora_backup"],
@@ -72,4 +72,6 @@ def run_full_installer(network, region):
         )
 
     # Start findorad
-    start_local_validator(ROOT_DIR, FINDORAD_IMG, "installer", network, CONTAINER_NAME, ENDPOINT_STATUS_URL, RETRY_INTERVAL)
+    start_local_validator(
+        ROOT_DIR, FINDORAD_IMG, "installer", network, CONTAINER_NAME, ENDPOINT_STATUS_URL, RETRY_INTERVAL
+    )

src/safety_clean.py

@@ -1,16 +1,16 @@
 import subprocess
 import os
-from config import findora_env
 from shared import (
     stop_and_remove_container,
     chown_dir,
     get_live_version,
     start_local_validator,
     load_server_data,
+    findora_env,
 )
 
 
-def run_safety_clean(network = os.environ.get("FRA_NETWORK"), region = os.environ.get("FRA_REGION")):
+def run_safety_clean(network=os.environ.get("FRA_NETWORK"), region=os.environ.get("FRA_REGION")):
     USERNAME = findora_env.active_user_name
     ENV = "prod"
     server_url = f"https://{ENV}-{network}.{ENV}.findora.org"
@@ -30,9 +30,18 @@ def run_safety_clean(network = os.environ.get("FRA_NETWORK"), region = os.enviro
 
     # get checkpoint on testnet
     if network == "testnet":
-        CHECKPOINT_URL = f"https://{ENV}-{network}-us-west-2-ec2-instance.s3.us-west-2.amazonaws.com/{network}/checkpoint"
+        CHECKPOINT_URL = (
+            f"https://{ENV}-{network}-us-west-2-ec2-instance.s3.us-west-2.amazonaws.com/{network}/checkpoint"
+        )
         subprocess.run(["sudo", "rm", "-rf", f"{ROOT_DIR}/checkpoint.toml"], check=True)
-        subprocess.run(["wget", "-O", f"{ROOT_DIR}/checkpoint.toml", f"{CHECKPOINT_URL}"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=True)
+        subprocess.run(
+            ["wget", "-O", f"{ROOT_DIR}/checkpoint.toml", f"{CHECKPOINT_URL}"],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+            check=True,
+        )
 
     # Start findorad
-    start_local_validator(ROOT_DIR, FINDORAD_IMG, "safety_clean", network, CONTAINER_NAME, ENDPOINT_STATUS_URL, RETRY_INTERVAL)
+    start_local_validator(
+        ROOT_DIR, FINDORAD_IMG, "safety_clean", network, CONTAINER_NAME, ENDPOINT_STATUS_URL, RETRY_INTERVAL
+    )

src/shared.py

@@ -8,8 +8,44 @@
 import urllib.request
 import tarfile
 import docker
-from colorama import Fore
-from config import findora_env
+import socket
+
+
+def get_url(timeout=5) -> str:
+    try:
+        response = requests.get("https://api.ipify.org?format=json", timeout=timeout)
+        response.raise_for_status()  # Raises a HTTPError if the response was unsuccessful
+
+        # Parse the JSON response
+        ip_data = response.json()
+        result = ip_data["ip"]
+    except requests.exceptions.RequestException as x:
+        try:
+            response = requests.get("https://ident.me", timeout=timeout)
+            response.raise_for_status()  # Raises a HTTPError if the response was unsuccessful
+            result = response.text
+        except requests.exceptions.RequestException as x:
+            print(type(x), x)
+            result = "0.0.0.0"
+    return result
+
+
+class findora_env:
+    toolbox_version = "1.3.1"
+    server_host_name = socket.gethostname()
+    user_home_dir = os.path.expanduser("~")
+    dotenv_file = f"{user_home_dir}/.findora.env"
+    active_user_name = os.path.split(user_home_dir)[-1]
+    findora_root = "/data/findora"
+    findora_root_mainnet = f"{findora_root}/mainnet"
+    findora_root_testnet = f"{findora_root}/testnet"
+    toolbox_location = os.path.join(user_home_dir, "findora-toolbox")
+    staker_memo_path = os.path.join(user_home_dir, "staker_memo")
+    our_external_ip = get_url()
+    container_name = "findorad"
+    migrate_dir = os.path.join(user_home_dir, "migrate")
+    fra_env = "prod"
+    findora_backup = os.path.join(user_home_dir, "findora_backup")
 
 
 def execute_command(command):
@@ -247,7 +283,8 @@ def load_server_data(ENV, network, ROOT_DIR, region):
 
     # Check available disk space
     required_space = snapshot_size * 2.5
-    available_space = get_available_space(SNAPSHOT_DIR)
+    available_space = get_available_space(ROOT_DIR)
+    final_size = available_space - required_space + snapshot_size
     if available_space < required_space:
         print(
             f"Error: Not enough disk space available. Minimum Required: {format_size(required_space)}+, Available: {format_size(available_space)}."
@@ -257,7 +294,7 @@ def load_server_data(ENV, network, ROOT_DIR, region):
             exit(1)
     else:
         print(
-            f"* Available disk space: {format_size(available_space)} - Estimated required space: {format_size(required_space)} - Estimated available space after unpacking: {format_size(available_space - required_space - snapshot_size)} "
+            f"* Available disk space: {format_size(available_space)} - Estimated required space: {format_size(required_space)} - Estimated available space after unpacking: {format_size(final_size)} "
         )
 
     # Extract the tar archive and check the exit status