Merge pull request #10 from rkdarst/add-gh-actions-tests

Add Github Actions to run tests

Author: stefanv

.github/workflows/test.yaml

@@ -0,0 +1,31 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  default:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ubuntu]
+        python-version: [3.10]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        pip install -r requirements.txt -r requirements.dev.txt
+
+    - name: Lint
+      run: pre-commit run --all-files --show-diff-on-failure --color always
+
+    - name: Test
+      run: |
+        PYTHONPATH=. pytest

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# Install pre-commit hooks via
+# pre-commit install
+
+repos:
+  - repo: https://github.com/psf/black
+    rev: 21.5b1
+    hooks:
+    - id: black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        pass_filenames: true
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort

requirements.dev.txt

@@ -0,0 +1,2 @@
+black==21.5b1
+pre-commit>=2.12

tests/test_calendar.py

@@ -2,38 +2,44 @@
 import io
 import textwrap
 
-from util import parse_yaml
-
 from yaml2ics import events_to_calendar, files_to_calendar
 
 
 def test_calendar_structure():
     cal = events_to_calendar([])
     cal_str = cal.serialize()
-    assert cal_str.startswith('BEGIN:VCALENDAR')
-    assert cal_str.endswith('END:VCALENDAR')
+    assert cal_str.startswith("BEGIN:VCALENDAR")
+    assert cal_str.endswith("END:VCALENDAR")
+
 
 def test_calendar_event():
     cal = files_to_calendar(
-        [io.StringIO(textwrap.dedent(
-            '''
+        [
+            io.StringIO(
+                textwrap.dedent(
+                    """
             events:
               - summary: Earth Day
                 begin: 2021-04-22
                 url: https://earthday.org
                 location: Earth
-            '''
-        ))]
+            """
+                )
+            )
+        ]
     )
     cal_str = cal.serialize()
-    assert cal_str.startswith('BEGIN:VCALENDAR')
-    assert 'SUMMARY:Earth Day' in cal_str
-    assert cal_str.endswith('END:VCALENDAR')
+    assert cal_str.startswith("BEGIN:VCALENDAR")
+    assert "SUMMARY:Earth Day" in cal_str
+    assert cal_str.endswith("END:VCALENDAR")
+
 
 def test_calendar_default_timezone():
     cal = files_to_calendar(
-        [io.StringIO(textwrap.dedent(
-            '''
+        [
+            io.StringIO(
+                textwrap.dedent(
+                    """
             meta:
               tz: Europe/Helsinki
 
@@ -48,23 +54,25 @@ def test_calendar_default_timezone():
 
               - summary: Earth day (all day)
                 begin: 2022-04-22
-            '''
-        ))]
+            """
+                )
+            )
+        ]
     )
     cal_str = cal.serialize()
-    assert cal_str.startswith('BEGIN:VCALENDAR')
-    assert 'SUMMARY:New year' in cal_str
+    assert cal_str.startswith("BEGIN:VCALENDAR")
+    assert "SUMMARY:New year" in cal_str
     # It is possible that the ics-py TZID string changes, but hopefully this
     # substring is fairly safe to test against.
-    assert 'Europe/Helsinki:20220101T000000' in cal_str
+    assert "Europe/Helsinki:20220101T000000" in cal_str
     # Second event: explicit UTC offset specified.
     assert '"UTC+02:00":20220201T000000' in cal_str
-    assert cal_str.endswith('END:VCALENDAR')
+    assert cal_str.endswith("END:VCALENDAR")
 
     # Test again by normalizing to UTC.  Helsinki is two hours ahead, so the
     # times should be 22:00:00.
     cal.normalize(datetime.timezone.utc)
-    cal_norm_str = cal.serialize()
+    cal_norm_str = cal.serialize()  # noqa: F841
     # 1 Feb midnight
-    assert 'DTSTART:20211231T220000Z' # 1 jan
-    assert 'DTSTART:20220131T220000Z' # 1 feb
+    assert "DTSTART:20211231T220000Z"  # 1 jan
+    assert "DTSTART:20220131T220000Z"  # 1 feb

tests/test_events.py

@@ -6,97 +6,96 @@
 def test_basic_structure():
     event = event_from_yaml(
         parse_yaml(
-            '''
+            """
             summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
             location: Earth
-            '''
+            """
         )
     )
 
     # All lines must be separated by CRLF
     event_str = event.serialize()
-    lines = event_str.split('\n')
+    lines = event_str.split("\n")
     for line in lines[:-1]:
-        assert line.endswith('\r')
-    assert 'SUMMARY:Earth Day' in event_str
-    assert 'URL:https://earthday.org' in event_str
-    assert 'LOCATION:Earth' in event_str
+        assert line.endswith("\r")
+    assert "SUMMARY:Earth Day" in event_str
+    assert "URL:https://earthday.org" in event_str
+    assert "LOCATION:Earth" in event_str
     # All events must have a DTSTAMP
-    assert 'DTSTAMP' in event_str
+    assert "DTSTAMP" in event_str
 
 
 def test_all_day_event():
     event = event_from_yaml(
         parse_yaml(
-            '''
+            """
             summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
-            '''
+            """
         )
     )
     event_str = event.serialize()
-    assert event_str.startswith('BEGIN:VEVENT')
-    assert event_str.endswith('END:VEVENT')
-    assert 'DTSTART;VALUE=DATE:20210422' in event_str
+    assert event_str.startswith("BEGIN:VEVENT")
+    assert event_str.endswith("END:VEVENT")
+    assert "DTSTART;VALUE=DATE:20210422" in event_str
     # ics 0.8.0 does have DTEND that is the next day.
-    #assert 'DTEND' not in event_str
+    # assert 'DTEND' not in event_str
 
 
 def test_rrule():
     event = event_from_yaml(
         parse_yaml(
-            '''
+            """
             summary: Earth Day
             begin: 2021-04-22
             url: https://earthday.org
             repeat:
               interval:
                 years: 1
               until: 2030-04-22
-            '''
+            """
         )
     )
     event_str = event.serialize()
     # DTEND exists and is the next day, calendar tools import this
     # correctly as being a one-day event
-    assert 'RRULE:FREQ=YEARLY;UNTIL=20300422T000000' in event_str
+    assert "RRULE:FREQ=YEARLY;UNTIL=20300422T000000" in event_str
 
 
 def test_event_with_time_range():
     event = event_from_yaml(
         parse_yaml(
-            '''
+            """
             summary: Event of the Century
             begin: 2021-09-21 15:00:00 -07:00
             end: 2021-09-21 15:30:00 -07:00
             description: |
               Meet the team on the northern side of the field.
-            '''
+            """
         )
     )
     event_str = event.serialize()
-    assert 'DTSTART' in event_str
-    assert 'DTEND' in event_str
+    assert "DTSTART" in event_str
+    assert "DTEND" in event_str
 
 
 def test_event_with_duration():
     event = event_from_yaml(
         parse_yaml(
-            '''
+            """
             summary: Event of the Century
             begin: 2021-09-21 15:00:00 -07:00
             duration:
               minutes: 30
             description: |
               Meet the team on the northern side of the field.
-            '''
+            """
         )
     )
     event_str = event.serialize()
-    assert 'DURATION:PT30M' in event_str
-    assert 'DTEND' not in event_str
-    assert 'DTSTART' in event_str
-
+    assert "DURATION:PT30M" in event_str
+    assert "DTEND" not in event_str
+    assert "DTSTART" in event_str

tests/util.py

@@ -1,9 +1,7 @@
-import yaml
 import textwrap
 
+import yaml
+
 
 def parse_yaml(yaml_str):
-    return yaml.load(
-        textwrap.dedent(yaml_str).strip(),
-        Loader=yaml.FullLoader
-    )
+    return yaml.load(textwrap.dedent(yaml_str).strip(), Loader=yaml.FullLoader)