Merge remote-tracking branch 'origin/develop'

Author: awdeorio

README.md

@@ -9,21 +9,11 @@ Autograder.io CLI (`agio`) is a command line interface to [autograder.io](https:
 
 
 ## Quick start
-First, [obtain a token](#obtaining-a-token) (below).
-
 ```console
 $ pip install agiocli
 $ agio
 ```
 
-## Obtaining a Token
-1. Log in [autograder.io](https://autograder.io/) with your web browser
-2. Open browser developer tools
-3. Click on a course link
-4. In the developer console, click on a request, e.g., `my_roles/` or `projects/`)
-5. Under Request Headers, there is an Authorization entry that looks like "Token ". Copy the hex string and save it to the file `.agtoken` in your home
-directory.
-
 ## Contributing
 Contributions from the community are welcome! Check out the [guide for contributing](CONTRIBUTING.md).
 

agiocli/__main__.py

@@ -52,6 +52,7 @@ def courses(ctx, course_arg, show_list, web):  # noqa: D301
     agio courses
     agio courses 109
     agio courses eecs485sp21
+    agio courses eecs485[cur|current]
 
     """
     try:

agiocli/api_client.py

@@ -151,21 +151,28 @@ def get_api_token(token_filename: str) -> str:
     - If token_filename is an absolute path or a relative path that contains
       at least one directory, that file will be opened and the token read.
     """
-    token_not_found_msg = f"Token file not found: {token_filename}"
+    # Token filename provided and it does not exist
     if os.path.dirname(token_filename) and not os.path.isfile(token_filename):
-        raise TokenFileNotFound(token_not_found_msg)
+        raise TokenFileNotFound("Token file does not exist: {token_filename}")
 
     # Make sure that we're starting in a subdir of the home directory
-    if os.path.expanduser('~') not in os.path.abspath(os.curdir):
-        raise TokenFileNotFound(token_not_found_msg)
+    curdir = os.path.abspath(os.curdir)
+    if os.path.expanduser('~') not in curdir:
+        raise TokenFileNotFound(f"Invalid search path: {curdir}")
 
+    # Search, walking up the directory structure from PWD to home
     for dirname in walk_up_to_home_dir():
         filename = os.path.join(dirname, token_filename)
         if os.path.isfile(filename):
             with open(filename, encoding="utf8") as tokenfile:
                 return tokenfile.read().strip()
 
-    raise TokenFileNotFound(token_not_found_msg)
+    # Didn't find a token file
+    raise TokenFileNotFound(
+        f"Token file not found: {token_filename}.  Download a token from "
+        f"https://autograder.io/web/__apitoken__ and save it to "
+        f"~/{token_filename} or ./{token_filename}"
+    )
 
 
 def walk_up_to_home_dir() -> Iterator[str]:

agiocli/utils.py

@@ -27,6 +27,22 @@
     9: 4, 10: 4, 11: 4, 12: 4,  # Sep-Dec Fall
 }
 
+# Map month number to semester name
+MONTH_SEMESTER_NAME = {
+    1: "Winter",
+    2: "Winter",
+    3: "Winter",
+    4: "Winter",
+    5: "Spring",
+    6: "Spring",
+    7: "Summer",
+    8: "Summer",
+    9: "Fall",
+    10: "Fall",
+    11: "Fall",
+    12: "Fall",
+}
+
 
 def dict_str(obj):
     """Format a dictionary as an indented string."""
@@ -113,29 +129,44 @@ def parse_course_string(user_input):
     [\s_-]*                     # Optional whitespace or delimiter
     (?P<num>\d{3})              # 3 digit course number
     [\s_-]*                     # Optional whitespace or delimiter
-    (?P<sem>                    # Semester name or abbreviation
+    (?P<sem>                    # Semester name or abbreviation or empty string
         w|wn|winter|
         sp|s|spring|
         su|summer|
         sp/su|spsu|ss|spring/summer|
-        f|fa|fall)
+        f|fa|fall|
+        cur|current|)
     [\s_-]*                     # Optional whitespace or delimiter
-    (?P<year>\d{2,4})           # 2-4 digit year
+    (?P<year>\d{2,4}|)          # 2-4 digit year or empty string
     \s*                         # Optional trailing whitespace
     $                           # Match ends at the end
     """
     match = re.search(pattern, user_input)
     if not match:
         sys.exit(f"Error: unsupported input format: '{user_input}'")
 
+    # User must provide either year and semester or neither.  Semester may be
+    # "cur" or "current."
+    year = match.group("year")
+    semester_abbrev = match.group("sem")
+    if bool(year) ^ (semester_abbrev not in ["", "cur", "current"]):
+        sys.exit(f"Error: unsupported input format: '{user_input}'")
+
+    # Default year and semester
+    if not year and semester_abbrev in ["", "cur", "current"]:
+        today = dt.date.today()
+        year = today.year
+        semester_abbrev = MONTH_SEMESTER_NAME[today.month]
+
     # Convert year to a number, handling 2-digit year as "20xx"
-    year = int(match.group("year"))
+    year = int(year)
     assert year >= 0
     if year < 100:
         year = 2000 + year
 
     # Convert semester abbreviation to semester name.  Make sure that the keys
     # match the abbreviations in the regular expression above.
+    semester_abbrev = semester_abbrev.lower()
     semester_names = {
         "w": "Winter",
         "wn": "Winter",
@@ -153,7 +184,6 @@ def parse_course_string(user_input):
         "fa": "Fall",
         "fall": "Fall",
     }
-    semester_abbrev = match.group("sem").lower()
     semester = semester_names[semester_abbrev]
 
     # Course name, with department and catalog number.  If no department is

setup.py

@@ -15,7 +15,7 @@
     description="A command line interface to autograder.io",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
-    version="0.2.0",
+    version="0.3.0",
     author="Andrew DeOrio",
     author_email="[email protected]",
     url="https://github.com/eecs485staff/agio-cli/",

tests/test_courses.py

@@ -57,12 +57,9 @@ def test_courses_empty(api_mock, mocker):
     }
     mocker.patch("pick.pick", return_value=(course_109, 1))
 
-    # Run agio, mocking the date to be Jun 2021.  We need to mock the date
-    # because the prompt filters out past courses.
-    # https://github.com/spulec/freezegun
+    # Run agio
     runner = click.testing.CliRunner()
-    with freezegun.freeze_time("2021-06-15"):
-        result = runner.invoke(main, ["courses"], catch_exceptions=False)
+    result = runner.invoke(main, ["courses"], catch_exceptions=False)
 
     # Check output
     assert result.exit_code == 0, result.output
@@ -122,3 +119,26 @@ def test_courses_shortcut(api_mock):
     assert result.exit_code == 0, result.output
     output_obj = json.loads(result.output)
     assert output_obj["pk"] == 109
+
+
+def test_courses_default_semester(api_mock):
+    """Verify courses subcommand with no semester/year shortcut input.
+
+    $ agio courses eecs485
+
+    api_mock is a shared test fixture that mocks responses to REST API
+    requests.  It is implemented in conftest.py.
+
+    """
+    # Run agio, mocking the date to be Jun 2021.  The current course should be
+    # spring 2021  https://github.com/spulec/freezegun
+    runner = click.testing.CliRunner()
+    with freezegun.freeze_time("2021-06-15"):
+        result = runner.invoke(
+            main, ["courses", "eecs485"],
+            catch_exceptions=False,
+        )
+
+    assert result.exit_code == 0, result.output
+    output_obj = json.loads(result.output)
+    assert output_obj["pk"] == 109

tests/test_groups.py

@@ -6,7 +6,6 @@
 import json
 import click
 import click.testing
-import freezegun
 from agiocli.__main__ import main
 
 
@@ -108,12 +107,9 @@ def test_groups_empty(api_mock, mocker, constants):
     ])
     mocker.patch("builtins.input", return_value="awdeorio")
 
-    # Run agio, mocking the date to be Jun 2021.  We need to mock the date
-    # because the prompt filters out past courses.
-    # https://github.com/spulec/freezegun
+    # Run agio
     runner = click.testing.CliRunner()
-    with freezegun.freeze_time("2021-06-15"):
-        result = runner.invoke(main, ["groups"], catch_exceptions=False)
+    result = runner.invoke(main, ["groups"], catch_exceptions=False)
 
     # Check output
     assert result.exit_code == 0, result.output

tests/test_matching.py

@@ -1,4 +1,5 @@
 """Unit tests for smart user input string matching."""
+import freezegun
 import pytest
 from agiocli import utils
 
@@ -91,6 +92,39 @@ def test_course_match_bad_year(search):
     assert not matches
 
 
+@pytest.mark.parametrize(
+    "search, expected_course_pk",
+    [
+        ("EECS 280", 111),
+        ("EECS 280 cur", 111),
+        ("EECS 280 current", 111),
+        ("eecs280", 111),
+        ("eecs280cur", 111),
+        ("eecs280current", 111),
+        ("eecs280-cur", 111),
+        ("eecs280-current", 111),
+        ("EECS 485", 109),
+        ("EECS 485 cur", 109),
+        ("EECS 485 current", 109),
+        ("eecs485", 109),
+        ("eecs485cur", 109),
+        ("eecs485current", 109),
+        ("eecs485-cur", 109),
+        ("eecs485-current", 109),
+
+    ]
+)
+def test_course_match_current(search, expected_course_pk):
+    """Auto select current semester."""
+    # Run course match, mocking the date to be June 2021
+    # https://github.com/spulec/freezegun
+    with freezegun.freeze_time("2021-06-15"):
+        matches = utils.course_match(search, COURSES)
+    assert len(matches) == 1
+    course = matches[0]
+    assert course["pk"] == expected_course_pk
+
+
 @pytest.mark.parametrize(
     "search, expected_project_pk",
     [

tests/test_projects.py

@@ -7,7 +7,6 @@
 import textwrap
 import click
 import click.testing
-import freezegun
 from agiocli.__main__ import main
 
 
@@ -117,15 +116,9 @@ def test_projects_no_course(api_mock, mocker, constants):
     # defined in conftest.py
     mocker.patch("pick.pick", return_value=(constants["COURSE_109"], 1))
 
-    # Run agio, mocking the date to be Jun 2021.  We need to mock the date
-    # because the prompt filters out past courses.
-    # https://github.com/spulec/freezegun
+    # Run agio
     runner = click.testing.CliRunner()
-    with freezegun.freeze_time("2021-06-15"):
-        result = runner.invoke(
-            main, ["projects", "p1"],
-            catch_exceptions=False,
-        )
+    result = runner.invoke(main, ["projects", "p1"], catch_exceptions=False)
 
     # Check output
     assert result.exit_code == 0, result.output
@@ -149,12 +142,9 @@ def test_projects_empty(api_mock, mocker, constants):
         (constants["PROJECT_1005"], 0),  # Second  call selects project
     ])
 
-    # Run agio, mocking the date to be Jun 2021.  We need to mock the date
-    # because the prompt filters out past courses.
-    # https://github.com/spulec/freezegun
+    # Run agio
     runner = click.testing.CliRunner()
-    with freezegun.freeze_time("2021-06-15"):
-        result = runner.invoke(main, ["projects"], catch_exceptions=False)
+    result = runner.invoke(main, ["projects"], catch_exceptions=False)
 
     # Check output
     assert result.exit_code == 0, result.output

tests/test_submissions.py

@@ -6,7 +6,6 @@
 import json
 import click
 import click.testing
-import freezegun
 from agiocli.__main__ import main
 
 
@@ -133,12 +132,9 @@ def test_submissions_empty(api_mock, mocker, constants):
     ])
     mocker.patch("builtins.input", return_value="awdeorio")
 
-    # Run agio, mocking the date to be Jun 2021.  We need to mock the date
-    # because the prompt filters out past courses.
-    # https://github.com/spulec/freezegun
+    # Run agio
     runner = click.testing.CliRunner()
-    with freezegun.freeze_time("2021-06-15"):
-        result = runner.invoke(main, ["submissions"], catch_exceptions=False)
+    result = runner.invoke(main, ["submissions"], catch_exceptions=False)
 
     # Check output
     assert result.exit_code == 0, result.output