Skip to content

Commit

Permalink
Merge pull request #24 from nbehrnd/master
Browse files Browse the repository at this point in the history 
lint pytest tests' setup
  • Loading branch information
@nbehrnd
nbehrnd authored Nov 22, 2024
2 parents 3b82ea4 + 956088b commit 683be70
Show file tree
Hide file tree
Showing 5 changed files with 188 additions and 199 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/pytest.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI_pytest_appendfilename
# name : pytest.yml
# purpose : regularly run pytest on appendfilename
# date : [2024-10-31 Thu]
# edit : [2024-11-12 Tue]
# edit : [2024-11-22 Fri]

on:
push:
Expand Down Expand Up @@ -43,7 +43,10 @@ jobs:

- name: run the check by pytest
run: |
echo "default"
python -m pytest -m "default"
echo "prepend"
python -m pytest -m "prepend"
python -m pytest -m "smart"
echo "smart_prepend"
python -m pytest -m "smart_prepend"
21 changes: 0 additions & 21 deletions Makefile
View file

This file was deleted.

6 changes: 3 additions & 3 deletions pytest.ini
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[pytest]
markers =
default: appendfilename's default string insertions
prepend: appendfilename's optional -p/--prepend flag
smart: appendfilename's optional --smart-prepend flag
default: test appendfilename's default string insertion
prepend: test appendfilename's optional -p/--prepend flag
smart_prepend: test appendfilename's optional --smart-prepend flag
154 changes: 81 additions & 73 deletions test_appendfilename.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@
# author: [email protected]
# license: GPL v3, 2022.
# date: 2022-01-05 (YYYY-MM-DD)
# edit: [2024-11-05 Tue]
# edit: [2024-11-22 Fri]
#
"""Test pad for functions by appendfilename with pytest.
Initially written for Python 3.9.9 and pytest 6.2.4 and recently update
for Python 3.12.6/pytest 8.3.3, this script provides a programmatic check
of functions offered by appendfilename. Deposit this script in the root of
the folder fetched and unzipped from PyPi or GitHub. Create a virtual
of functions offered by appendfilename. Deposit this script in the root
of the folder fetched and unzipped from PyPi or GitHub. Create a virtual
environment for Python, e.g. by
```shell
python -m venv sup
```
In the activated virtual environment, ensure the dependencies are met -
either by `pip install pyreadline3 pytest`, or `pip install -r requirements.txt`
- and launch the tests by
In the activated virtual environment, resolve the dependencies - either by
`pip install pyreadline3 pytest`, or `pip install -r requirements.txt` -
and launch the tests by
```shell
python -m pytest
Expand All @@ -29,26 +29,31 @@
As a reminder, the following optional pytest flags may be useful to obtain
a report tailored to your needs:
- `-x` exits right after the first failing test (reported by `E` instead of `.`)
- `-x` exit after the first failing test (reported by `E` instead of `.`)
- `-v` provide a more verbose output
- `-s` equally report the test criterion, e.g. the queried file name
Equally keep in mind you can constrain pytest tests. Labels assigned are
- default: test appendfilename's default string insertion
- prepend: test appendfilename's optional -p/--prepend flag
- smart_prepend: test appendfilename's optional --smart-prepend flag
"""

import re
import os
import shlex
import sys
import subprocess

from itertools import product

import pytest

PROGRAM = os.path.join("appendfilename", "__init__.py") # Cross-platform path
PROGRAM = os.path.join("appendfilename", "__init__.py")

# The following section tests the applications default pattern where a string
# is added to the file name, just prior to the file's file extension. The
# permutation of the three arguments and their levels defines 120 tests.
# The following section tests the applications default pattern where a
# string is added to the file name, just prior to the file's file
# extension. The permutations of the arguments define 120 tests.

arg1_values = [
"test.txt", "2021-12-31_test.txt", "2021-12-31T18.48.22_test.txt"
Expand All @@ -68,11 +73,14 @@
"--separator '='",
"--separator '-'"
]
# Note: The check with pytest and `*` as separator in Windows 10 fails.
# Note: In Windows 10, the check with pytest and `*` as separator fails
# because it is not a permitted character in a file name there. See
# <https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file>

# create the permutations:
test_cases = list(product(arg1_values, arg2_values, arg3_values))


@pytest.mark.default
@pytest.mark.parametrize("arg1, arg2, arg3", test_cases)
def test_append(arg1, arg2, arg3):
Expand All @@ -89,7 +97,7 @@ def test_append(arg1, arg2, arg3):
# run the test to be tested:
full_command = ["python", PROGRAM, arg1
] + shlex.split(arg2) + shlex.split(arg3)
subprocess.run(full_command, text = True, check = True)
subprocess.run(full_command, text=True, check=True)

# construct the new file name to be tested:
if len(shlex.split(arg3)) == 0:
Expand All @@ -98,9 +106,8 @@ def test_append(arg1, arg2, arg3):
separator = shlex.split(arg3)[1]

new_filename = "".join(
[ arg1[:-4], separator,
shlex.split(arg2)[1], ".txt" ])
print(f"test criterion: {new_filename}") # visible by optional `pytest -s`
[arg1[:-4], separator, shlex.split(arg2)[1], ".txt"])
print(f"test criterion: {new_filename}") # for an optional `pytest -s`

# is the new file present?
assert os.path.isfile(new_filename)
Expand All @@ -109,9 +116,10 @@ def test_append(arg1, arg2, arg3):
os.remove(new_filename)
assert os.path.isfile(new_filename) is False

# The following section is about tests to prepend a user defined string and
# an adjustable separator to the original file name of the file submitted. By
# permutation of the parameter's levels, this defines 240 tests.
# The following section is about tests to prepend a user defined string
# and an adjustable separator to the original file name of the submitted
# file. The permutation of the parameters defines 240 tests.


arg1_values = [
"test.txt", "2021-12-31_test.txt", "2021-12-31T18.48.22_test.txt"
Expand Down Expand Up @@ -140,6 +148,7 @@ def test_append(arg1, arg2, arg3):
# create the permutations:
test_cases = list(product(arg1_values, arg2_values, arg3_values, arg4_values))


@pytest.mark.prepend
@pytest.mark.parametrize("arg1, arg2, arg3, arg4", test_cases)
def test_prepend(arg1, arg2, arg3, arg4):
Expand All @@ -158,15 +167,15 @@ def test_prepend(arg1, arg2, arg3, arg4):
full_command = [
"python", PROGRAM, arg1
] + shlex.split(arg2) + shlex.split(arg3) + shlex.split(arg4)
subprocess.run(full_command, text = True, check = True)
subprocess.run(full_command, text=True, check=True)

# construct the new file name to be tested:
if len(shlex.split(arg3)) == 0:
separator = " "
else:
separator = shlex.split(arg3)[1]

new_filename = "".join( [ shlex.split(arg2)[1], separator, arg1 ] )
new_filename = "".join([shlex.split(arg2)[1], separator, arg1])
print(f"test criterion: {new_filename}") # visible by optional `pytest -s`

# is the new file present?
Expand All @@ -179,12 +188,13 @@ def test_prepend(arg1, arg2, arg3, arg4):
# This section tests the insertion of a string into the file's file name
# just after the file's time or date stamp as provided `date2name`.


arg1_values = [
"2021-12-31T18.48.22_test.txt",
"2021-12-31_test.txt",
# "20211231_test.txt", # by now `20211231_test.txt` -> 20211231_test ping.txt
# "2021-12_test.txt", # by now `2021-12_test.txt` -> `2021-12_test ping.txt`
# "211231_test.txt" # by now `211231_test.txt` -> `211231_test ping.txt`
# "20211231_test.txt", # by now `20211231_test.txt` -> 20211231_test ping.txt
# "2021-12_test.txt", # by now `2021-12_test.txt` -> `2021-12_test ping.txt`
# "211231_test.txt" # by now `211231_test.txt` -> `211231_test ping.txt`
]
arg2_values = [
"-t book",
Expand All @@ -194,15 +204,15 @@ def test_prepend(arg1, arg2, arg3, arg4):
]
arg3_values = [
"", # i.e. fall back to default single space
# "--separator '!'",
# "--separator '@'",
# "--separator '#'",
# "--separator '$'",
# "--separator '%'",
# "--separator '_'",
# "--separator '+'",
# "--separator '='",
# "--separator '-'"
# "--separator '!'",
# "--separator '@'",
# "--separator '#'",
# "--separator '$'",
# "--separator '%'",
# "--separator '_'",
# "--separator '+'",
# "--separator '='",
# "--separator '-'"
]
# Note: The check with pytest and `*` as separator in Windows 10 fails.
# Contrasting to Linux Debian 13, a `pytest` in Windows 10 revealed every
Expand All @@ -211,7 +221,8 @@ def test_prepend(arg1, arg2, arg3, arg4):
# create the permutations:
test_cases = list(product(arg1_values, arg2_values, arg3_values))

@pytest.mark.smart

@pytest.mark.smart_prepend
@pytest.mark.parametrize("arg1, arg2, arg3", test_cases)
def test_smart_prepend(arg1, arg2, arg3):
"""test the insertion of a new string just past the time stamp
Expand All @@ -220,18 +231,18 @@ def test_smart_prepend(arg1, arg2, arg3):
arg2 the text string to be added
arg3 the separator (at least in Windows 10, do not use `*`
"""
time_stamp = ""
time_stamp_separator = ""
timestamp = ""
# timestamp_separator = ""
old_filename_no_timestamp = ""

# create a test file:
with open(arg1, mode="w", encoding="utf-8") as newfile:
newfile.write("this is a placeholder\n")

#run `appendfilename` on this test file
# run `appendfilename` on this test file
run_appendfilename = " ".join(
["python", PROGRAM, arg1, arg2, arg3, " --smart-prepend"])
subprocess.run(run_appendfilename, shell=True, check = True)
subprocess.run(run_appendfilename, shell=True, check=True)

# construct the new file name to be testedt:
old_filename = arg1
Expand All @@ -242,7 +253,7 @@ def test_smart_prepend(arg1, arg2, arg3):
else:
separator = shlex.split(arg3)[1]

# Time stamps `date2name` provides can be either one of five formats
# Timestamps `date2name` provides can be either one of five formats
#
# YYYY-MM-DDTHH.MM.SS `--withtime`
# YYYY-MM-DD default
Expand All @@ -258,42 +269,39 @@ def test_smart_prepend(arg1, arg2, arg3):
# https://github.com/novoid/appendfilename/issues/15
# https://github.com/novoid/appendfilename/issues/16

# pattern `--with-time`
if re.search(r"^\d{4}-[012]\d-[0-3]\dT[012]\d\.[0-5]\d\.[0-5]\d", old_filename):
time_stamp = old_filename[:19]
time_stamp_separator = old_filename[19]
old_filename_no_timestamp = old_filename[20:]

# default pattern
elif re.search(r"^\d{4}-[012]\d-[0-3]\d", old_filename):
time_stamp = old_filename[:10]
time_stamp_separator = old_filename[10]
old_filename_no_timestamp = old_filename[11:]

# pattern `--compact` # currently fails
elif re.search(r"^\d{4}[012]\d[0-3]\d", old_filename):
time_stamp = old_filename[:8]
time_stamp_separator = old_filename[8]
old_filename_no_timestamp = old_filename[9:]

# pattern `--month` # currently fails
elif re.search(r"^\d{4}-[012]\d", old_filename):
time_stamp = old_filename[:7]
time_stamp_separator = old_filename[7]
old_filename_no_timestamp = old_filename[8:]

# pattern `--short` # currently fails
elif re.search(r"^\d{4}[012]\d[0-3]\d", old_filename):
time_stamp = old_filename[:6]
time_stamp_separator = old_filename[6]
old_filename_no_timestamp = old_filename[7:]

new_filename = "".join([time_stamp, #time_stamp_separator,
patterns = [
r"^\d{4}-[012]\d-[0-3]\dT[012]\d\.[0-5]\d\.[0-5]\d",
r"^\d{4}-[012]\d-[0-3]\d",
r"^\d{4}[012]\d[0-3]\d",
r"^\d{4}-[012]\d",
r"^\d{2}[012]\d[0-3]\d"
]

for pattern in patterns:
match = re.search(pattern, old_filename)
if match:
timestamp = re.findall(pattern, old_filename)[0]
timestamp_separator = str(old_filename)[len(timestamp)]
old_filename_no_timestamp = old_filename[len(timestamp) + 1:]

print("\n\ntest of option smart-prepend:") # `pytest -s` diagnosis
print("old_filename:")
print(old_filename)
print("timestamp, timestamp_separator, old_filename_no_timestamp")
print(timestamp)
print(timestamp_separator)
print(old_filename_no_timestamp)

break

new_filename = "".join([
timestamp, # timestamp_separator,
separator, shlex.split(arg2)[1], separator,
old_filename_no_timestamp ])
old_filename_no_timestamp
])

# is the new file present?
print("\nnew_filename") # optional check for `pytest -s`
print("new_filename") # optional check for `pytest -s`
print(new_filename)
assert os.path.isfile(new_filename)

Expand Down
Loading

0 comments on commit 683be70

Please sign in to comment.