-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* store status changes with timestamps, show run time based on those timestamps * fix some bugs * refactor StatusHistory into it's own dataclass * create new file specific to status * add tests for StatusHistory * add pytest to pre-commit * attempt to fix github runner * remove demo_test, accidentally added * update .gitignore * clean up mere commit
1 parent
8b6b38d
commit 771b88e
Showing
14 changed files
with
265 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ tmp/ | |
IGNORE-ME* | ||
.pyre/* | ||
.draft | ||
.coverage* | ||
|
||
# local env files | ||
.env*.local | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
{ | ||
"site_package_search_strategy": "pep561", | ||
"source_directories": [ | ||
"sidecar" | ||
{"import_root": ".", "source": "sidecar"} | ||
] | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
from __future__ import annotations | ||
|
||
import time | ||
from dataclasses import dataclass, field | ||
from enum import IntEnum, auto | ||
from pathlib import Path | ||
from typing import NamedTuple | ||
|
||
import loguru | ||
|
||
|
||
class Status(IntEnum): | ||
UNKNOWN = auto() | ||
NOT_FOUND = auto() | ||
STARTING = auto() | ||
COMPILING = auto() | ||
WAITING_TO_START = auto() | ||
IN_PROGRESS = auto() | ||
COMPLETE = auto() | ||
KILLED = auto() | ||
CRASHED = auto() | ||
|
||
|
||
StatusChangeEvent = NamedTuple( | ||
"StatusChangeEvent", [("status", Status), ("timestamp", float)] | ||
) | ||
|
||
|
||
@dataclass | ||
class StatusHistory: | ||
file_path: Path = field(init=True, repr=False) | ||
logger: loguru.Logger = field(init=True, repr=False, compare=False) | ||
_status_history: list[StatusChangeEvent] = field( | ||
init=False, default_factory=list, repr=True | ||
) | ||
|
||
def __post_init__(self): | ||
if self.file_path.exists(): | ||
self.logger.debug(f"Loading status history from file {self.file_path}") | ||
with self.file_path.open("r", encoding="utf8") as f: | ||
for line in f: | ||
status_str, timestamp = line.split(",") | ||
self._status_history.append( | ||
StatusChangeEvent( | ||
status=Status[status_str], timestamp=float(timestamp) | ||
) | ||
) | ||
|
||
@property | ||
def locking_status(self): | ||
"""Cannot add to history after this or higher status is reached""" | ||
return Status.COMPLETE | ||
|
||
def add(self, status: Status, timestamp: float = time.time()): | ||
assert status > self.current_status | ||
assert self.current_status < self.locking_status | ||
self._status_history.append( | ||
StatusChangeEvent(status=status, timestamp=timestamp) | ||
) | ||
with self.file_path.open("a", encoding="utf8") as f: | ||
self.logger.debug(f"updating status: {status=}") | ||
f.write(f"{status.name},{timestamp}\n") | ||
|
||
@property | ||
def current_status_event(self): | ||
if not self._status_history: | ||
return StatusChangeEvent(status=Status.UNKNOWN, timestamp=time.time()) | ||
return self._status_history[-1] | ||
|
||
@property | ||
def current_status(self): | ||
return self.current_status_event.status | ||
|
||
@property | ||
def status_event_json(self): | ||
status_event = { | ||
"status": self.current_status_event.status.name, | ||
"start_time": self.current_status_event.timestamp, | ||
} | ||
if self.current_status >= Status.COMPLETE and len(self._status_history) >= 2: | ||
status_event["start_time"] = self._status_history[-2].timestamp | ||
status_event["end_time"] = self.current_status_event.timestamp | ||
return status_event |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
import time | ||
from pathlib import Path | ||
|
||
import loguru | ||
import pytest | ||
|
||
from sidecar.app.query.status import Status, StatusChangeEvent, StatusHistory | ||
|
||
|
||
@pytest.fixture(name="status_history_fixture") | ||
def _status_history_fixture(tmp_path): | ||
status_history = StatusHistory( | ||
file_path=tmp_path / Path("status"), | ||
logger=loguru.logger, | ||
) | ||
|
||
return status_history | ||
|
||
|
||
@pytest.fixture(name="full_status_history_fixture") | ||
def _full_status_history_fixture(status_history_fixture): | ||
status_events = [ | ||
(Status.STARTING, 1.0), | ||
(Status.COMPILING, 2.0), | ||
(Status.WAITING_TO_START, 3.0), | ||
(Status.IN_PROGRESS, 4.0), | ||
(Status.COMPLETE, 5.0), | ||
] | ||
|
||
for status, timestamp in status_events: | ||
status_history_fixture.add(status, timestamp) | ||
|
||
return status_history_fixture | ||
|
||
|
||
def test_status_history_add(status_history_fixture): | ||
now = time.time() | ||
status_history_fixture.add(Status.COMPILING, now) | ||
assert status_history_fixture.current_status_event == StatusChangeEvent( | ||
Status.COMPILING, now | ||
) | ||
now = time.time() | ||
status_history_fixture.add(Status.IN_PROGRESS, now) | ||
assert status_history_fixture.current_status_event == StatusChangeEvent( | ||
Status.IN_PROGRESS, now | ||
) | ||
|
||
|
||
def test_status_history_add_write_to_file(status_history_fixture): | ||
status_history_fixture.add(Status.COMPILING, 1.0) | ||
status_history_fixture.add(Status.IN_PROGRESS, 2.0) | ||
with status_history_fixture.file_path.open("r", encoding="utf-8") as f: | ||
assert f.readline() == "COMPILING,1.0\n" | ||
assert f.readline() == "IN_PROGRESS,2.0\n" | ||
|
||
|
||
def test_status_history_add_load_from_file(tmp_path, full_status_history_fixture): | ||
status_history = StatusHistory( | ||
file_path=tmp_path / Path("status"), | ||
logger=loguru.logger, | ||
) | ||
assert status_history == full_status_history_fixture | ||
|
||
|
||
def test_status_history_cannot_add_when_locked(full_status_history_fixture): | ||
with pytest.raises(AssertionError): | ||
now = time.time() | ||
full_status_history_fixture.add(Status.KILLED, now) | ||
|
||
|
||
def test_status_history_cannot_add_lower_status(status_history_fixture): | ||
now = time.time() | ||
status_history_fixture.add(Status.IN_PROGRESS, now) | ||
assert status_history_fixture.current_status_event == StatusChangeEvent( | ||
Status.IN_PROGRESS, now | ||
) | ||
with pytest.raises(AssertionError): | ||
now = time.time() | ||
status_history_fixture.add(Status.COMPILING, now) | ||
|
||
|
||
def test_status_history_current_status_event(full_status_history_fixture): | ||
assert full_status_history_fixture.current_status_event == StatusChangeEvent( | ||
Status.COMPLETE, 5.0 | ||
) | ||
|
||
|
||
def test_status_history_current_status(full_status_history_fixture): | ||
assert full_status_history_fixture.current_status == Status.COMPLETE | ||
|
||
|
||
def test_status_history_status_event_json( | ||
status_history_fixture, | ||
): | ||
now = time.time() | ||
status_history_fixture.add(Status.COMPILING, now) | ||
assert status_history_fixture.status_event_json == { | ||
"status": Status.COMPILING.name, | ||
"start_time": now, | ||
} | ||
|
||
now = time.time() | ||
status_history_fixture.add(Status.IN_PROGRESS, now) | ||
assert status_history_fixture.status_event_json == { | ||
"status": Status.IN_PROGRESS.name, | ||
"start_time": now, | ||
} | ||
|
||
now2 = time.time() | ||
status_history_fixture.add(Status.COMPLETE, now2) | ||
assert status_history_fixture.status_event_json == { | ||
"status": Status.COMPLETE.name, | ||
"start_time": now, | ||
"end_time": now2, | ||
} |