Github/appendfilename
2
0
Fork 1
mirror of https://github.com/novoid/appendfilename.git synced 2026-06-14 12:21:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

refactor: edit tests about default append of a string

Browse source 
The checks about appendfilename's default, i.e. to insert a string
just prior to the file extension were edited.  This aims to provide
better portability of the tests when launching pytest either in
Linux Debian 13/trixie, or Windows 10.

Signed-off-by: Norwid Behrnd <nbehrnd@yahoo.com>
This commit is contained in:
Norwid Behrnd 2024-11-03 19:13:53 +01:00
parent 140671f28f
commit 2341fb1d89
2 changed files with 122 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
test_appendfilename.py
View file

@ -4,8 +4,8 @@
# author: nbehrnd@yahoo.com # author: nbehrnd@yahoo.com
# license: GPL v3, 2022. # license: GPL v3, 2022.
# date: 2022-01-05 (YYYY-MM-DD) # date: 2022-01-05 (YYYY-MM-DD)
# edit: [2024-10-31 Thu] # edit: [2024-11-03 Sun]
#
"""Test pad for functions by appendfilename with pytest. """Test pad for functions by appendfilename with pytest.
Written for Python 3.9.9 and pytest 6.2.4 for Python 3 as provided by Written for Python 3.9.9 and pytest 6.2.4 for Python 3 as provided by
@ -26,44 +26,73 @@ cases, the progress of the ongoing tests is reported to the CLI (flag -v)."""
import re import re
import os import os
import pytest import shlex
import sys import sys
import subprocess import subprocess
from pathlib import Path from itertools import product
from subprocess import getstatusoutput, getoutput
PROGRAM = str(Path("appendfilename") / "__init__.py") # Cross-platform path import pytest
@pytest.mark.default PROGRAM = os.path.join("appendfilename", "__init__.py") # Cross-platform path
@pytest.mark.parametrize("arg1", ["test.txt", "2021-12-31_test.txt",
"2021-12-31T18.48.22_test.txt"])
@pytest.mark.parametrize("arg2", ["-t book", "-t book_shelf"])#,
# "--text book", "--text book_shelf"])
#@pytest.mark.parametrize("arg3", [" ", "!", "@", "#", "$", "%", "*", "_", "+",
@pytest.mark.parametrize("arg3", [" ", "!", "@", "#", "$", "%", "_", "+",
"=", "-"])
def test_pattern_s1(arg1, arg2, arg3):
"""Check addition just ahead the file extension.
arg1 the test files to process # 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.
arg1_values = [
"test.txt", "2021-12-31_test.txt", "2021-12-31T18.48.22_test.txt"
]
arg2_values = [
"-t book", "-t book_shelf", "--text book", "--text book_shelf"
]
arg3_values = [
"", # i.e. fall back to default single space
"--separator '!'",
"--separator '@'",
"--separator '#'",
"--separator '$'",
"--separator '%'",
"--separator '_'",
"--separator '+'",
"--separator '='",
"--separator '-'"
]
# Note: The check with pytest and `*` as separator in Windows 10 fails.
# create the permutations:
test_cases = list(product(arg1_values, arg2_values, arg3_values))
@pytest.mark.parametrize("arg1, arg2, arg3", test_cases)
def test_append(arg1, arg2, arg3):
"""Test default which appends a string just prior file extension
arg1 the test file to process, partly inspired by `date2name`
arg2 the text string to be added arg2 the text string to be added
arg3 the explicitly defined text separator (except [a-zA-Z])""" arg3 the separator (at least in Windows 10, do not use `*`)"""
# extract the newly added text information: # create a test file:
text_elements = arg2.split(" ")[1:] with open(arg1, mode="w", encoding="utf-8") as newfile:
text = str(" ".join(text_elements)) newfile.write("This is a place holder.\n")
with open(arg1, mode="w") as newfile: # run the test to be tested:
newfile.write("This is a test file for test_appendfilename.") full_command = ["python", PROGRAM, arg1
] + shlex.split(arg2) + shlex.split(arg3)
subprocess.run(full_command, text = True, check = True)
# Run the command with cross-platform Python executable and file paths # construct the new file name to be tested:
result = subprocess.run( if len(shlex.split(arg3)) == 0:
[sys.executable, PROGRAM, arg1, arg2, f"--separator={arg3}"], separator = " "
capture_output=True, text=True, check=True) else:
separator = shlex.split(arg3)[1]
new_filename = "".join([arg1[:-4], arg3, " ", text, str(".txt")]) new_filename = "".join(
[ arg1[:-4], separator,
shlex.split(arg2)[1], ".txt" ])
print(f"test criterion: {new_filename}") # visible by optional `pytest -s`
# is the new file present?
assert os.path.isfile(new_filename) assert os.path.isfile(new_filename)
# space cleaning # check if the OS can process the new file / space cleaning
os.remove(new_filename) os.remove(new_filename)
assert os.path.isfile(new_filename) is False

90
test_generator.org
View file

@ -1,7 +1,7 @@
# name: test_generator.org # name: test_generator.org
# author: nbehrnd@yahoo.com # author: nbehrnd@yahoo.com
# date: 2022-01-05 (YYYY-MM-DD) # date: 2022-01-05 (YYYY-MM-DD)
# edit: [2024-10-31 Thu] # edit: [2024-11-03 Sun]
# license: GPL3, 2022. # license: GPL3, 2022.
# Export the tangled files with C-c C-v t # Export the tangled files with C-c C-v t
@ -168,6 +168,7 @@ markers =
** Building the test script ** Building the test script
*** header section *** header section
#+BEGIN_SRC python :tangle test_appendfilename.py #+BEGIN_SRC python :tangle test_appendfilename.py
#!/bin/usr/env python3 #!/bin/usr/env python3
@ -175,7 +176,7 @@ markers =
# author: nbehrnd@yahoo.com # author: nbehrnd@yahoo.com
# license: GPL v3, 2022. # license: GPL v3, 2022.
# date: 2022-01-05 (YYYY-MM-DD) # date: 2022-01-05 (YYYY-MM-DD)
# edit: [2024-10-31 Thu] # edit: [2024-11-03 Sun]
# #
"""Test pad for functions by appendfilename with pytest. """Test pad for functions by appendfilename with pytest.
@ -197,14 +198,15 @@ cases, the progress of the ongoing tests is reported to the CLI (flag -v)."""
import re import re
import os import os
import pytest import shlex
import sys import sys
import subprocess import subprocess
from pathlib import Path from itertools import product
from subprocess import getstatusoutput, getoutput
PROGRAM = str(Path("appendfilename") / "__init__.py") # Cross-platform path import pytest
PROGRAM = os.path.join("appendfilename", "__init__.py") # Cross-platform path
#+end_src #+end_src
*** appendfilename, default position *** appendfilename, default position
@ -214,39 +216,67 @@ PROGRAM = str(Path("appendfilename") / "__init__.py") # Cross-platform path
containing spaces, as well as the implicit spacing. containing spaces, as well as the implicit spacing.
#+begin_src python :tangle test_appendfilename.py #+begin_src python :tangle test_appendfilename.py
@pytest.mark.default # The following section tests the applications default pattern where a string
@pytest.mark.parametrize("arg1", ["test.txt", "2021-12-31_test.txt", # is added to the file name, just prior to the file's file extension. The
"2021-12-31T18.48.22_test.txt"]) # permutation of the three arguments and their levels defines 120 tests.
@pytest.mark.parametrize("arg2", ["-t book", "-t book_shelf"])#,
# "--text book", "--text book_shelf"])
#@pytest.mark.parametrize("arg3", [" ", "!", "@", "#", "$", "%", "*", "_", "+",
@pytest.mark.parametrize("arg3", [" ", "!", "@", "#", "$", "%", "_", "+",
"=", "-"])
def test_pattern_s1(arg1, arg2, arg3):
"""Check addition just ahead the file extension.
arg1 the test files to process arg1_values = [
"test.txt", "2021-12-31_test.txt", "2021-12-31T18.48.22_test.txt"
]
arg2_values = [
"-t book", "-t book_shelf", "--text book", "--text book_shelf"
]
arg3_values = [
"", # i.e. fall back to default single space
"--separator '!'",
"--separator '@'",
"--separator '#'",
"--separator '$'",
"--separator '%'",
"--separator '_'",
"--separator '+'",
"--separator '='",
"--separator '-'"
]
# Note: The check with pytest and `*` as separator in Windows 10 fails.
# create the permutations:
test_cases = list(product(arg1_values, arg2_values, arg3_values))
@pytest.mark.parametrize("arg1, arg2, arg3", test_cases)
def test_append(arg1, arg2, arg3):
"""Test default which appends a string just prior file extension
arg1 the test file to process, partly inspired by `date2name`
arg2 the text string to be added arg2 the text string to be added
arg3 the explicitly defined text separator (except [a-zA-Z])""" arg3 the separator (at least in Windows 10, do not use `*`)"""
# extract the newly added text information: # create a test file:
text_elements = arg2.split(" ")[1:] with open(arg1, mode="w", encoding="utf-8") as newfile:
text = str(" ".join(text_elements)) newfile.write("This is a place holder.\n")
with open(arg1, mode="w") as newfile: # run the test to be tested:
newfile.write("This is a test file for test_appendfilename.") full_command = ["python", PROGRAM, arg1
] + shlex.split(arg2) + shlex.split(arg3)
subprocess.run(full_command, text = True, check = True)
# Run the command with cross-platform Python executable and file paths # construct the new file name to be tested:
result = subprocess.run( if len(shlex.split(arg3)) == 0:
[sys.executable, PROGRAM, arg1, arg2, f"--separator={arg3}"], separator = " "
capture_output=True, text=True, check=True) else:
separator = shlex.split(arg3)[1]
new_filename = "".join([arg1[:-4], arg3, " ", text, str(".txt")]) new_filename = "".join(
[ arg1[:-4], separator,
shlex.split(arg2)[1], ".txt" ])
print(f"test criterion: {new_filename}") # visible by optional `pytest -s`
# is the new file present?
assert os.path.isfile(new_filename) assert os.path.isfile(new_filename)
# space cleaning # check if the OS can process the new file / space cleaning
os.remove(new_filename) os.remove(new_filename)
assert os.path.isfile(new_filename) is False
#+end_src #+end_src
*** appendfilename, prepend position *** appendfilename, prepend position