Add basic tests (#56)

* refactor: minor project structure changes

* chore: git ignore data

* chore: adjust gitignore transcripts dir

* test: add some basic tests

* test: execute tests on every branch

* test: rm redundant comment

.github/workflows/test.yaml

@@ -0,0 +1,22 @@
+# .github/workflows/streamlit-app.yml
+name: Test streamlit app
+
+on:
+  push:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+
+jobs:
+  test_streamlit_app:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12.3"
+      - uses: streamlit/streamlit-app-action@v0.0.3
+        with:
+          app-path: main.py

.gitignore

@@ -6,7 +6,10 @@ design/
 test/
 certs/
 *.ipynb
-transcripts/
+transcripts*/
+/data/chroma/*
+!/data/chroma/.gitkeep
+*.sqlite3
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

Dockerfile

@@ -1,5 +1,5 @@
 # Base stage for shared environment setup
-FROM python:3.12-slim
+FROM python:3.12.3-slim
 
 # Set working directory
 WORKDIR /app
@@ -14,6 +14,7 @@ RUN pip3 install -r requirements.txt
 COPY . /app/
 
 # Streamlit's configuration options
+ENV PYTHONPATH="/app"
 ENV STREAMLIT_CLIENT_TOOLBAR_MODE="viewer"
 ENV STREAMLIT_SERVER_PORT=8501
 

main.py

@@ -121,9 +121,10 @@ def main():
         )
         custom_prompt = st.text_area(
             "Enter a custom prompt if you want:",
+            key="custom_prompt_input",
             help=get_default_config_value("help_texts.custom_prompt"),
         )
-        summarize_button = st.button("Summarize")
+        summarize_button = st.button("Summarize", key="summarize_button")
 
         if url != "":
             try:

requirements.txt

@@ -2,4 +2,5 @@ youtube-transcript-api==0.6.2
 langchain-community==0.2.4
 langchain-openai==0.1.8
 streamlit==1.35.0
-watchdog==4.0.1
+watchdog==4.0.1
+pytest==8.2.2