Add compilation tests (#165)

- Outsourced the tests into seperate python scripts
- Added new compilability test

Author: Tim-Grube

.github/workflows/build_and_test.yml

@@ -13,7 +13,7 @@ jobs:
         uses: actions/checkout@v4
       - uses: xu-cheng/texlive-action@v2
         with:
-          scheme: full  # Consider changing to 'basic' or 'medium' if possible
+          scheme: full # Consider changing to 'basic' or 'medium' if possible
           run: |
             apk add make
             apk add g++
@@ -40,41 +40,18 @@ jobs:
       - name: Install pdfgrep
         run: sudo apt-get update && sudo apt-get install -y pdfgrep
 
-      - name: Extract and Check URLs
-        run: |
-          urls=$(pdfgrep -o -P 'https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)' vorkurs.pdf | sort -u)
-          error_count=0
+      - name: Install required python package
+        run: pip install urllib3
 
-          for url in $urls; do
-            echo "Checking URL: $url"
+      - name: Run Link Checker
+        run: python .github/workflows/test_scripts/check_links.py
 
-            if [[ ! "$url" =~ ^https:// ]]; then
-              echo "ERROR: URL is not HTTPS: $url"
-              error_count=$((error_count + 1))
-              continue
-            fi
-
-            if ! curl -Isf --fail-early --connect-timeout 10 "$url" > /dev/null 2>&1; then
-              curl_error=$(curl -Isf --fail-early --connect-timeout 10 "$url" 2>&1 > /dev/null)
-              if [[ $curl_error == *"Failed to connect"* ]]; then
-                echo "ERROR: Connection failed: $url"
-              elif [[ $curl_error == *"Could not resolve host"* ]]; then
-                echo "ERROR: DNS resolution failed: $url"
-              elif [[ $curl_error == *"SSL certificate problem"* ]]; then
-                 echo "ERROR: Initial SSL certificate problem: $url"
-              else
-                echo "ERROR: Failed to access: $url (curl error: $curl_error)"
-              fi
-              if ! openssl s_client -connect "$(echo "$url" | sed 's/https\?:\/\///' | cut -d/ -f1):443" -servername "$(echo "$url" | sed 's/https\?:\/\///' | cut -d/ -f1)" 2>/dev/null </dev/null | openssl x509 -noout; then
-                 echo "  -> CERTIFICATE ERROR DETECTED!"
-              fi
-
-              error_count=$((error_count + 1))
-            fi
-          done
+  check-compilability:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-          if [ "$error_count" -gt 0 ]; then
-            echo "::error::Found $error_count broken or insecure links!"
-            exit 1
-          fi
-        shell: bash
+      - name: Run compilability checker
+        run: python .github/workflows/test_scripts/check_compilability.py

.github/workflows/test_scripts/check_compilability.py

@@ -0,0 +1,65 @@
+import pathlib
+import subprocess
+
+# Thats where our cpps are currently
+BASE_PATH = "vorkurs/"
+
+
+def find_all_cpp_files(findWorking):
+    vorkurs_path = pathlib.Path(BASE_PATH)
+    broken_cpp_files = set(vorkurs_path.rglob("*broken.cpp"))
+
+    if not findWorking:
+        return [str(cpp_file) for cpp_file in broken_cpp_files]
+
+    cpp_files = set(vorkurs_path.rglob("*.cpp"))
+    working_cpp_files = cpp_files.difference(broken_cpp_files)
+    return [str(cpp_file) for cpp_file in working_cpp_files]
+
+
+def test_single_cpp_file(file_path, shouldCompile):
+    compile_status = subprocess.getoutput(f"g++ {file_path}")
+
+    if (compile_status != "" and shouldCompile) or (
+        compile_status == "" and not shouldCompile
+    ):
+        print("\n" + 20 * "=")
+        print(f"Error in file {file_path}:\n")
+        print(compile_status)
+        print(20 * "=" + "\n")
+        return False
+
+    return True
+
+
+def main():
+    error_count_working = 0
+    error_count_broken = 0
+    working_cpp_files = find_all_cpp_files(True)
+    broken_cpp_files = find_all_cpp_files(False)
+
+    for cpp_file in working_cpp_files:
+        if not test_single_cpp_file(cpp_file, True):
+            error_count_working += 1
+
+    for cpp_file in broken_cpp_files:
+        if not test_single_cpp_file(cpp_file, False):
+            error_count_broken += 1
+
+    if error_count_working > 0:
+        print(
+            f"::error::Found {error_count_working} non compiling files which should compile"
+        )
+        exit(1)
+
+    if error_count_broken > 0:
+        print(
+            f"::error:Found {error_count_broken} files that should be broken but compile"
+        )
+        exit(1)
+
+    exit(0)
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/test_scripts/check_links.py

@@ -0,0 +1,59 @@
+import re
+import subprocess
+import ssl
+import socket
+from urllib.parse import urlparse
+
+def extract_urls(file_path):
+    with open(file_path, 'r', encoding='latin-1') as file:
+        content = file.read()
+    url_pattern = re.compile(r'https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)')
+    urls = url_pattern.findall(content)
+    return sorted(set(url[0] for url in urls))
+
+def check_url(url):
+    if not url.startswith("https://"):
+        print(f"ERROR: URL is not HTTPS: {url}")
+        return False
+
+    try:
+        subprocess.run(["curl", "-Isf", "--fail-early", "--connect-timeout", "10", url], check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+    except subprocess.CalledProcessError as e:
+        curl_error = e.stderr.decode() if e.stderr else ""
+        if "Failed to connect" in curl_error:
+            print(f"ERROR: Connection failed: {url}")
+        elif "Could not resolve host" in curl_error:
+            print(f"ERROR: DNS resolution failed: {url}")
+        elif "SSL certificate problem" in curl_error:
+            print(f"ERROR: Initial SSL certificate problem: {url}")
+        else:
+            print(f"ERROR: Failed to access: {url} (curl error: {curl_error})")
+
+        hostname = urlparse(url).hostname
+        try:
+            with socket.create_connection((hostname, 443), timeout=10) as sock:
+                context = ssl.create_default_context()
+                with context.wrap_socket(sock, server_hostname=hostname) as ssock:
+                    ssock.do_handshake()
+        except ssl.SSLError:
+            print("  -> CERTIFICATE ERROR DETECTED!")
+        return False
+    return True
+
+def main():
+    file_path = "vorkurs.pdf"
+    urls = extract_urls(file_path)
+    error_count = 0
+
+    for url in urls:
+        print(f"Checking URL: {url}")
+        if not check_url(url):
+            error_count += 1
+
+    if error_count > 0:
+        print(f"::error::Found {error_count} broken or insecure links!")
+        exit(1)
+
+if __name__ == "__main__":
+    main()
+