OpenOrchestrator 1.1.0__tar.gz → 1.2.0__tar.gz

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/database/db_util.py

@@ -601,9 +601,7 @@ def begin_scheduled_trigger(trigger_id: str) -> bool:
 
         trigger.process_status = TriggerStatus.RUNNING
         trigger.last_run = datetime.now()
-
-        next_run = croniter(trigger.cron_expr, trigger.next_run).get_next(datetime)
-        trigger.next_run = next_run
+        trigger.next_run = croniter(trigger.cron_expr, datetime.now()).get_next(datetime)
 
         session.commit()
         return True

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/orchestrator/application.py

@@ -1,6 +1,8 @@
 """This module is the entry point for the Orchestrator app. It contains a single class
 that when created starts the application."""
 
+import socket
+
 from nicegui import ui, app
 
 from OpenOrchestrator.orchestrator.tabs.trigger_tab import TriggerTab
@@ -39,7 +41,7 @@ class Application():
         app.on_connect(self.update_loop)
         app.on_disconnect(app.shutdown)
         app.on_exception(lambda exc: ui.notify(exc, type='negative'))
-        ui.run(title="Orchestrator", favicon='🤖', native=False, port=23406, reload=False)
+        ui.run(title="Orchestrator", favicon='🤖', native=False, port=get_free_port(), reload=False)
 
     def update_tab(self):
         """Update the date in the currently selected tab."""
@@ -73,5 +75,20 @@ class Application():
             ''')
 
 
+def get_free_port():
+    """Get a free port by creating a new socket and bind it
+    on port 0 allowing the os to select the port.
+    https://docs.python.org/3/library/socket.html#socket.create_connection
+
+    Returns:
+        A port number that should be free to use.
+    """
+    with socket.socket() as sock:
+        sock.bind(("", 0))
+        port = sock.getsockname()[1]
+
+    return port
+
+
 if __name__ in {'__main__', '__mp_main__'}:
     Application()

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/orchestrator/tabs/queue_tab.py

@@ -33,7 +33,7 @@ class QueueTab():
     """The 'Queues' tab object. It contains tables and buttons for dealing with queues."""
     def __init__(self, tab_name: str) -> None:
         with ui.tab_panel(tab_name):
-            self.queue_table = ui.table(title="Queues", columns=QUEUE_COLUMNS, rows=[], row_key='Queue Name', pagination=10).classes("w-full")
+            self.queue_table = ui.table(title="Queues", columns=QUEUE_COLUMNS, rows=[], row_key='Queue Name', pagination=50).classes("w-full")
             self.queue_table.on("rowClick", self._row_click)
 
     def update(self):

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/orchestrator/tabs/trigger_tab.py

@@ -30,7 +30,7 @@ class TriggerTab():
                 ui.button("New Scheduled Trigger", icon="add", on_click=lambda e: TriggerPopup(self, TriggerType.SCHEDULED))
                 ui.button("New Queue Trigger", icon="add", on_click=lambda e: TriggerPopup(self, TriggerType.QUEUE))
 
-            self.trigger_table = ui.table(COLUMNS, [], title="Triggers", pagination=10, row_key='ID').classes("w-full")
+            self.trigger_table = ui.table(COLUMNS, [], title="Triggers", pagination=50, row_key='ID').classes("w-full")
             self.trigger_table.on('rowClick', self._row_click)
 
             self.add_column_colors()

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/scheduler/application.py

@@ -26,7 +26,7 @@ class Application(tkinter.Tk):
         notebook = ttk.Notebook(self)
         notebook.pack(expand=True, fill='both')
 
-        run_tab_ = run_tab.create_tab(notebook, self)
+        run_tab_ = run_tab.RunTab(notebook, self)
         settings_tab_ = settings_tab.create_tab(notebook)
 
         notebook.add(run_tab_, text='Run')

OpenOrchestrator-1.2.0/OpenOrchestrator/scheduler/run_tab.py

@@ -0,0 +1,175 @@
+"""This module is responsible for the layout and functionality of the run tab
+in Scheduler."""
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+import tkinter
+from tkinter import ttk
+import sys
+
+from sqlalchemy import exc as alc_exc
+
+from OpenOrchestrator.common import crypto_util
+from OpenOrchestrator.database import db_util
+from OpenOrchestrator.scheduler import runner
+
+if TYPE_CHECKING:
+    from OpenOrchestrator.scheduler.application import Application
+
+
+# pylint: disable-next=too-many-ancestors
+class RunTab(ttk.Frame):
+    """A ttk.frame object containing the functionality of the run tab in Scheduler."""
+    def __init__(self, parent: ttk.Notebook, app: Application):
+        super().__init__(parent)
+        self.pack(fill='both', expand=True)
+
+        self.app = app
+
+        s = ttk.Style()
+        s.configure('my.TButton', font=('Helvetica Bold', 24))
+        self.button = ttk.Button(self, text="Run", command=self.button_click, style='my.TButton')
+        self.button.pack()
+
+        # Text area
+        text_frame = tkinter.Frame(self)
+        text_frame.pack()
+
+        self.text_area = tkinter.Text(text_frame, state='disabled', wrap='none')
+
+        # Redirect stdout to the text area instead of console
+        sys.stdout.write = self.print_text
+
+        # Add scroll bars to text area
+        text_yscroll = ttk.Scrollbar(text_frame, orient='vertical', command=self.text_area.yview)
+        text_yscroll.pack(side='right', fill='y')
+        self.text_area.configure(yscrollcommand=text_yscroll.set)
+
+        text_xscroll = ttk.Scrollbar(text_frame, orient='horizontal', command=self.text_area.xview)
+        text_xscroll.pack(side='bottom', fill='x')
+        self.text_area.configure(xscrollcommand=text_xscroll.set)
+
+        self.text_area.pack()
+
+    def button_click(self):
+        """Callback for when the run/pause button is clicked."""
+        if self.app.running:
+            self.pause()
+        else:
+            self.run()
+
+    def pause(self):
+        """Stops the Scheduler and sets the app's status to 'paused'."""
+        self.button.configure(text="Run")
+        print('Paused... Please wait for all processes to stop before closing the application\n')
+        self.app.running = False
+
+    def run(self):
+        """Starts the Scheduler and sets the app's status to 'running'."""
+        if db_util.get_conn_string() is None:
+            print("Can't start without a valid connection string. Go to the settings tab to configure the connection string")
+            return
+        if crypto_util.get_key() is None:
+            print("Can't start without a valid encryption key. Go to the settings tab to configure the encryption key")
+            return
+
+        self.button.configure(text="Pause")
+        print('Running...\n')
+        self.app.running = True
+
+        # Only start a new loop if it's not already running
+        if self.app.tk.call('after', 'info') == '':
+            self.app.after(0, loop, self.app)
+
+    def print_text(self, text: str) -> None:
+        """Appends text to the text area.
+        Is used to replace the functionality of sys.stdout.write (print).
+
+        Args:
+            string: The string to append.
+        """
+        # Insert text at the end
+        self.text_area.configure(state='normal')
+        self.text_area.insert('end', text)
+
+        # If the number of lines are above 1000 delete 10 lines from the top
+        num_lines = int(self.text_area.index('end').split('.', maxsplit=1)[0])
+        if num_lines > 1000:
+            self.text_area.delete("1.0", "10.0")
+
+        # Scroll to end
+        self.text_area.see('end')
+        self.text_area.configure(state='disabled')
+
+
+def loop(app: Application) -> None:
+    """The main loop function of the Scheduler.
+    Checks heartbeats, check triggers, and schedules the next loop.
+
+    Args:
+        app: The Scheduler Application object.
+    """
+    try:
+        check_heartbeats(app)
+
+        if app.running:
+            check_triggers(app)
+
+    except alc_exc.OperationalError:
+        print("Couldn't connect to database.")
+
+    if len(app.running_jobs) == 0:
+        print("Doing cleanup...")
+        runner.clear_repo_folder()
+
+    # Schedule next loop
+    if app.running or len(app.running_jobs) > 0:
+        print('Waiting 6 seconds...\n')
+        app.after(6_000, loop, app)
+    else:
+        print("Scheduler is paused and no more processes are running.")
+
+
+def check_heartbeats(app: Application) -> None:
+    """Check if any running jobs are still running, failed or done.
+
+    Args:
+        app: The Scheduler Application object.
+    """
+    print('Checking heartbeats...')
+    for job in app.running_jobs:
+        if job.process.poll() is not None:
+            if job.process.returncode == 0:
+                print(f"Process '{job.trigger.process_name}' is done")
+                runner.end_job(job)
+            else:
+                print(f"Process '{job.trigger.process_name}' failed. Check process log for more info.")
+                runner.fail_job(job)
+
+            app.running_jobs.remove(job)
+        else:
+            print(f"Process '{job.trigger.process_name}' is still running")
+
+
+def check_triggers(app: Application) -> None:
+    """Checks any process is blocking
+    and if not checks if any trigger should be run.
+
+    Args:
+        app: The Scheduler Application object.
+    """
+    # Check if process is blocking
+    blocking = False
+    for job in app.running_jobs:
+        if job.trigger.is_blocking:
+            print(f"Process '{job.trigger.process_name}' is blocking\n")
+            blocking = True
+
+    # Check triggers
+    if not blocking:
+        print('Checking triggers...')
+        job = runner.poll_triggers(app)
+
+        if job is not None:
+            app.running_jobs.append(job)

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/OpenOrchestrator/scheduler/runner.py

@@ -16,6 +16,7 @@ class Job():
     """An object that holds information about a running job."""
     process: subprocess.Popen
     trigger: Trigger
+    process_folder: str
 
 
 def poll_triggers(app) -> Job | None:
@@ -66,10 +67,7 @@ def run_single_trigger(trigger: SingleTrigger) -> Job | None:
     print('Running trigger: ', trigger.trigger_name)
 
     if db_util.begin_single_trigger(trigger.id):
-        process = run_process(trigger)
-
-        if process is not None:
-            return Job(process, trigger)
+        return run_process(trigger)
 
     return None
 
@@ -88,10 +86,7 @@ def run_scheduled_trigger(trigger: ScheduledTrigger) -> Job | None:
     print('Running trigger: ', trigger.trigger_name)
 
     if db_util.begin_scheduled_trigger(trigger.id):
-        process = run_process(trigger)
-
-        if process is not None:
-            return Job(process, trigger)
+        return run_process(trigger)
 
     return None
 
@@ -109,10 +104,7 @@ def run_queue_trigger(trigger: QueueTrigger) -> Job | None:
     print('Running trigger: ', trigger.trigger_name)
 
     if db_util.begin_queue_trigger(trigger.id):
-        process = run_process(trigger)
-
-        if process is not None:
-            return Job(process, trigger)
+        return run_process(trigger)
 
     return None
 
@@ -142,7 +134,7 @@ def clone_git_repo(repo_url: str) -> str:
 def clear_repo_folder() -> None:
     """Completely remove the repos folder."""
     repo_folder = get_repo_folder_path()
-    subprocess.run(['rmdir', '/s', '/q', repo_folder], check=False, shell=True, capture_output=True)
+    clear_folder(repo_folder)
 
 
 def get_repo_folder_path() -> str:
@@ -156,6 +148,15 @@ def get_repo_folder_path() -> str:
     return repo_path
 
 
+def clear_folder(folder_path: str) -> None:
+    """Clear a folder on the system.
+
+    Args:
+        folder_path: The folder to remove.
+    """
+    subprocess.run(['rmdir', '/s', '/q', folder_path], check=False, shell=True, capture_output=True)
+
+
 def find_main_file(folder_path: str) -> str:
     """Finds the file in the given folder with the name 'main.py'.
     The search checks subfolders recursively.
@@ -193,6 +194,9 @@ def end_job(job: Job) -> None:
     elif isinstance(job.trigger, QueueTrigger):
         db_util.set_trigger_status(job.trigger.id, TriggerStatus.IDLE)
 
+    if job.process_folder:
+        clear_folder(job.process_folder)
+
 
 def fail_job(job: Job) -> None:
     """Mark a job as failed in the triggers table in the database.
@@ -205,8 +209,11 @@ def fail_job(job: Job) -> None:
     error_msg = f"An uncaught error ocurred during the process:\n{error}"
     db_util.create_log(job.trigger.process_name, LogLevel.ERROR, error_msg)
 
+    if job.process_folder:
+        clear_folder(job.process_folder)
 
-def run_process(trigger: Trigger) -> subprocess.Popen | None:
+
+def run_process(trigger: Trigger) -> Job | None:
     """Runs the process of the given trigger with the necessary inputs:
     Process name
     Connection string
@@ -224,14 +231,15 @@ def run_process(trigger: Trigger) -> subprocess.Popen | None:
         trigger: The trigger whose process to run.
 
     Returns:
-        subprocess.Popen: The Popen instance of the process if successful.
+        Job: A Job object referencing the process if succesful.
     """
     process_path = trigger.process_path
+    folder_path = None
 
     try:
         if trigger.is_git_repo:
-            git_folder_path = clone_git_repo(process_path)
-            process_path = find_main_file(git_folder_path)
+            folder_path = clone_git_repo(process_path)
+            process_path = find_main_file(folder_path)
 
         if not os.path.isfile(process_path):
             raise ValueError(f"The process path didn't point to a file on the system. Path: '{process_path}'")
@@ -244,7 +252,9 @@ def run_process(trigger: Trigger) -> subprocess.Popen | None:
 
         command_args = ['python', process_path, trigger.process_name, conn_string, crypto_key, trigger.process_args]
 
-        return subprocess.Popen(command_args, stderr=subprocess.PIPE, text=True)
+        process = subprocess.Popen(command_args, stderr=subprocess.PIPE, text=True)  # pylint: disable=consider-using-with
+
+        return Job(process, trigger, folder_path)
 
     # We actually want to catch any exception here
     # pylint: disable=broad-exception-caught

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0/OpenOrchestrator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OpenOrchestrator
-Version: 1.1.0
+Version: 1.2.0
 Summary: A package containing OpenOrchestrator and OpenOrchestrator Scheduler
 Author-email: ITK Development <itk-rpa@mkb.aarhus.dk>
 Project-URL: Homepage, https://github.com/itk-dev-rpa/OpenOrchestrator

{OpenOrchestrator-1.1.0/OpenOrchestrator.egg-info → OpenOrchestrator-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OpenOrchestrator
-Version: 1.1.0
+Version: 1.2.0
 Summary: A package containing OpenOrchestrator and OpenOrchestrator Scheduler
 Author-email: ITK Development <itk-rpa@mkb.aarhus.dk>
 Project-URL: Homepage, https://github.com/itk-dev-rpa/OpenOrchestrator

{OpenOrchestrator-1.1.0 → OpenOrchestrator-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OpenOrchestrator"
-version = "1.1.0"
+version = "1.2.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]

OpenOrchestrator-1.1.0/OpenOrchestrator/scheduler/run_tab.py

@@ -1,177 +0,0 @@
-"""This module is responsible for the layout and functionality of the run tab
-in Scheduler."""
-
-import tkinter
-from tkinter import ttk
-import sys
-
-from OpenOrchestrator.common import crypto_util
-from OpenOrchestrator.database import db_util
-from OpenOrchestrator.scheduler import runner
-
-
-def create_tab(parent: ttk.Notebook, app) -> ttk.Frame:
-    """Create a new Run tab object.
-
-    Args:
-        parent: The ttk.Notebook object that this tab is a child of.
-        app: The Scheduler application object.
-
-    Returns:
-        ttk.Frame: The created tab object as a ttk.Frame.
-    """
-    tab = ttk.Frame(parent)
-    tab.pack(fill='both', expand=True)
-
-    status_label = ttk.Label(tab, text="State: Paused")
-    status_label.pack()
-
-    ttk.Button(tab, text="Run", command=lambda: run(app, status_label)).pack()
-    ttk.Button(tab, text="Pause", command=lambda: pause(app, status_label)).pack()
-
-    # Text area
-    text_frame = tkinter.Frame(tab)
-    text_frame.pack()
-
-    text_area = tkinter.Text(text_frame, state='disabled', wrap='none')
-    sys.stdout.write = lambda s: print_text(text_area, s)
-
-    text_yscroll = ttk.Scrollbar(text_frame, orient='vertical', command=text_area.yview)
-    text_yscroll.pack(side='right', fill='y')
-    text_area.configure(yscrollcommand=text_yscroll.set)
-
-    text_xscroll = ttk.Scrollbar(text_frame, orient='horizontal', command=text_area.xview)
-    text_xscroll.pack(side='bottom', fill='x')
-    text_area.configure(xscrollcommand=text_xscroll.set)
-
-    text_area.pack()
-
-    return tab
-
-
-def run(app, status_label: ttk.Label) -> None:
-    """Starts the Scheduler and sets the app's status to 'running'.
-
-    Args:
-        app: The Scheduler application object.
-        status_label: The label showing the current status.
-    """
-    if db_util.get_conn_string() is None:
-        print("Can't start without a valid connection string. Go to the settings tab to configure the connection string")
-        return
-    if crypto_util.get_key() is None:
-        print("Can't start without a valid encryption key. Go to the settings tab to configure the encryption key")
-        return
-
-    if not app.running:
-        status_label.configure(text='State: Running')
-        print('Running...\n')
-        app.running = True
-
-        # Only start loop if it's not already running
-        if app.tk.call('after', 'info') == '':
-            app.after(0, loop, app)
-
-
-def pause(app, status_label: ttk.Label):
-    """Stops the Scheduler and sets the app's status to 'paused'.
-
-    Args:
-        app: The Scheduler application object.
-        status_label: The label showing the current status.
-    """
-    if app.running:
-        status_label.configure(text="State: Paused")
-        print('Paused... Please wait for all processes to stop before closing the application\n')
-        app.running = False
-
-
-def print_text(text_widget: tkinter.Text, text: str) -> None:
-    """Appends text to the text area.
-    Is used to replace the functionality of sys.stdout.write (print).
-
-    Args:
-        print_text: The text area object.
-        string: The string to append.
-    """
-    # Insert text at the end
-    text_widget.configure(state='normal')
-    text_widget.insert('end', text)
-
-    # If the number of lines are above 1000 delete 10 lines from the top
-    num_lines = int(text_widget.index('end').split('.')[0])
-    if num_lines > 1000:
-        text_widget.delete("1.0", "10.0")
-
-    # Scroll to end
-    text_widget.see('end')
-    text_widget.configure(state='disabled')
-
-
-def loop(app) -> None:
-    """The main loop function of the Scheduler.
-    Checks heartbeats, check triggers, and schedules the next loop.
-
-    Args:
-        app: The Scheduler Application object.
-    """
-    check_heartbeats(app)
-
-    if app.running:
-        check_triggers(app)
-
-    if len(app.running_jobs) == 0:
-        print("Doing cleanup...")
-        runner.clear_repo_folder()
-
-    # Schedule next loop
-    if app.running or len(app.running_jobs) > 0:
-        print('Waiting 6 seconds...\n')
-        app.after(6_000, loop, app)
-    else:
-        print("Scheduler is paused and no more processes are running.")
-
-
-def check_heartbeats(app) -> None:
-    """Check if any running jobs are still running, failed or done.
-
-    Args:
-        app: The Scheduler Application object.
-    """
-    print('Checking heartbeats...')
-    for job in app.running_jobs:
-        if job.process.poll() is not None:
-            app.running_jobs.remove(job)
-
-            if job.process.returncode == 0:
-                print(f"Process '{job.trigger.process_name}' is done")
-                runner.end_job(job)
-            else:
-                print(f"Process '{job.trigger.process_name}' failed. Check process log for more info.")
-                runner.fail_job(job)
-
-        else:
-            print(f"Process '{job.trigger.process_name}' is still running")
-
-
-def check_triggers(app) -> None:
-    """Checks any process is blocking
-    and if not checks if any trigger should be run.
-
-    Args:
-        app: The Scheduler Application object.
-    """
-    # Check if process is blocking
-    blocking = False
-    for job in app.running_jobs:
-        if job.trigger.is_blocking:
-            print(f"Process '{job.trigger.process_name}' is blocking\n")
-            blocking = True
-
-    # Check triggers
-    if not blocking:
-        print('Checking triggers...')
-        job = runner.poll_triggers(app)
-
-        if job is not None:
-            app.running_jobs.append(job)