mirror of https://github.com/eyhc1/rendercv.git
530 lines
20 KiB
Python
530 lines
20 KiB
Python
import unittest
|
|
import os
|
|
import json
|
|
from datetime import date
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
|
|
from rendercv import rendering, data_model
|
|
|
|
|
|
class TestRendering(unittest.TestCase):
|
|
def test_markdown_to_latex(self):
|
|
input = "[link](www.example.com)"
|
|
expected = r"\hrefExternal{www.example.com}{link}"
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="only one link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[link](www.example.com) and [link2](www.example2.com)"
|
|
expected = (
|
|
r"\hrefExternal{www.example.com}{link} and"
|
|
r" \hrefExternal{www.example2.com}{link2}"
|
|
)
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="two links"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[**link**](www.example.com)"
|
|
expected = r"\hrefExternal{www.example.com}{\textbf{link}}"
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="bold link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[*link*](www.example.com)"
|
|
expected = r"\hrefExternal{www.example.com}{\textit{link}}"
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="italic link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[*link*](www.example.com) and [**link2**](www.example2.com)"
|
|
expected = (
|
|
r"\hrefExternal{www.example.com}{\textit{link}} and"
|
|
r" \hrefExternal{www.example2.com}{\textbf{link2}}"
|
|
)
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="italic and bold links"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "**bold**, *italic*, and [link](www.example.com)"
|
|
expected = (
|
|
r"\textbf{bold}, \textit{italic}, and"
|
|
r" \hrefExternal{www.example.com}{link}"
|
|
)
|
|
output = rendering.markdown_to_latex(input)
|
|
with self.subTest(msg="bold, italic, and link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
# invalid input:
|
|
input = 20
|
|
with self.subTest(msg="float input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.markdown_to_latex(input) # type: ignore
|
|
|
|
def test_markdown_link_to_url(self):
|
|
input = "[link](www.example.com)"
|
|
expected = "www.example.com"
|
|
output = rendering.markdown_link_to_url(input)
|
|
with self.subTest(msg="only one link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[**link**](www.example.com)"
|
|
expected = "www.example.com"
|
|
output = rendering.markdown_link_to_url(input)
|
|
with self.subTest(msg="bold link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "[*link*](www.example.com)"
|
|
expected = "www.example.com"
|
|
output = rendering.markdown_link_to_url(input)
|
|
with self.subTest(msg="italic link"):
|
|
self.assertEqual(output, expected)
|
|
|
|
# invalid input:
|
|
input = 20
|
|
with self.subTest(msg="float input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.markdown_link_to_url(input) # type: ignore
|
|
|
|
input = "not a markdown link"
|
|
with self.subTest(msg="invalid input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.markdown_link_to_url(input)
|
|
|
|
input = "[]()"
|
|
with self.subTest(msg="empty link"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.markdown_link_to_url(input)
|
|
|
|
def test_make_it_something(self):
|
|
# invalid input:
|
|
input = "test"
|
|
keyword = "invalid keyword"
|
|
with self.subTest(msg="invalid keyword"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.make_it_something(input, keyword)
|
|
|
|
def test_make_it_bold(self):
|
|
input = "some text"
|
|
expected = r"\textbf{some text}"
|
|
output = rendering.make_it_bold(input)
|
|
with self.subTest(msg="without match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
match_str = "text"
|
|
expected = r"some \textbf{text}"
|
|
output = rendering.make_it_bold(input, match_str)
|
|
with self.subTest(msg="with match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
match_str = 2423
|
|
with self.subTest(msg="invalid match_str input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.make_it_bold(input, match_str) # type: ignore
|
|
|
|
input = 20
|
|
with self.subTest(msg="float input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.make_it_bold(input) # type: ignore
|
|
|
|
def test_make_it_underlined(self):
|
|
input = "some text"
|
|
expected = r"\underline{some text}"
|
|
output = rendering.make_it_underlined(input)
|
|
with self.subTest(msg="without match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "some text"
|
|
match_str = "text"
|
|
expected = r"some \underline{text}"
|
|
output = rendering.make_it_underlined(input, match_str)
|
|
with self.subTest(msg="with match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = 20
|
|
with self.subTest(msg="float input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.make_it_underlined(input) # type: ignore
|
|
|
|
def test_make_it_italic(self):
|
|
input = "some text"
|
|
expected = r"\textit{some text}"
|
|
output = rendering.make_it_italic(input)
|
|
with self.subTest(msg="without match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = "some text"
|
|
match_str = "text"
|
|
expected = r"some \textit{text}"
|
|
output = rendering.make_it_italic(input, match_str)
|
|
with self.subTest(msg="with match_str input"):
|
|
self.assertEqual(output, expected)
|
|
|
|
input = 20
|
|
with self.subTest(msg="float input"):
|
|
with self.assertRaises(ValueError):
|
|
rendering.make_it_italic(input) # type: ignore
|
|
|
|
def test_divide_length_by(self):
|
|
lengths = [
|
|
"10cm",
|
|
"10.24in",
|
|
"10 pt",
|
|
"10.24 mm",
|
|
"10.24 em",
|
|
"1024 ex",
|
|
]
|
|
divider = 10
|
|
expected = [
|
|
"1.0 cm",
|
|
"1.024 in",
|
|
"1.0 pt",
|
|
"1.024 mm",
|
|
"1.024 em",
|
|
"102.4 ex",
|
|
]
|
|
for length, exp in zip(lengths, expected):
|
|
with self.subTest(length=length, msg="valid input"):
|
|
self.assertEqual(rendering.divide_length_by(length, divider), exp)
|
|
|
|
def test_get_today(self):
|
|
expected = date.today().strftime("%B %d, %Y")
|
|
result = rendering.get_today()
|
|
self.assertEqual(expected, result, msg="Today's date is not correct.")
|
|
|
|
def test_get_path_to_font_directory(self):
|
|
font_name = "test"
|
|
expected = os.path.join(
|
|
os.path.dirname(os.path.dirname(__file__)),
|
|
"rendercv",
|
|
"templates",
|
|
"fonts",
|
|
font_name,
|
|
)
|
|
result = rendering.get_path_to_font_directory(font_name)
|
|
self.assertEqual(expected, result, msg="Font directory path is not correct.")
|
|
|
|
def test_read_input_file(self):
|
|
test_input = {
|
|
"cv": {
|
|
"name": "John Doe",
|
|
}
|
|
}
|
|
|
|
# write dictionary to a file as json:
|
|
input_file_path = os.path.join(os.path.dirname(__file__), "test_input.json")
|
|
json_string = json.dumps(test_input)
|
|
with open(input_file_path, "w") as file:
|
|
file.write(json_string)
|
|
|
|
# read the file:
|
|
result = rendering.read_input_file(input_file_path)
|
|
|
|
# remove the file:
|
|
os.remove(input_file_path)
|
|
|
|
with self.subTest(msg="read input file"):
|
|
self.assertEqual(
|
|
result.cv.name,
|
|
test_input["cv"]["name"],
|
|
)
|
|
|
|
with self.subTest(msg="nonexistent file"):
|
|
with self.assertRaises(FileNotFoundError):
|
|
rendering.read_input_file("nonexistent.json")
|
|
|
|
def test_render_template(self):
|
|
test_input = {
|
|
"cv": {
|
|
"academic_projects": [
|
|
{
|
|
"date": "Spring 2022",
|
|
"highlights": ["Test 1", "Test 2"],
|
|
"location": "Istanbul, Turkey",
|
|
"name": "Academic Project 1",
|
|
"url": "https://example.com",
|
|
},
|
|
{
|
|
"highlights": ["Test 1", "Test 2"],
|
|
"name": "Academic Project 2",
|
|
"url": "https://example.com",
|
|
},
|
|
{
|
|
"end_date": "2022-05-01",
|
|
"highlights": ["Test 1", "Test 2"],
|
|
"location": "Istanbul, Turkey",
|
|
"name": "Academic Project 3",
|
|
"start_date": "2022-02-01",
|
|
"url": "https://example.com",
|
|
},
|
|
],
|
|
"certificates": [{"name": "Certificate 1"}],
|
|
"education": [
|
|
{
|
|
"area": "Mechanical Engineering",
|
|
"end_date": "1985-01-01",
|
|
"gpa": "3.80/4.00",
|
|
"highlights": ["Test 1", "Test 2"],
|
|
"institution": "Bogazici University",
|
|
"location": "Istanbul, Turkey",
|
|
"start_date": "1980-09-01",
|
|
"study_type": "BS",
|
|
"transcript_url": "https://example.com/",
|
|
"url": "https://boun.edu.tr",
|
|
},
|
|
{
|
|
"area": "Mechanical Engineering, Student Exchange Program",
|
|
"end_date": "2022-01-15",
|
|
"institution": "The University of Texas at Austin",
|
|
"location": "Austin, TX, USA",
|
|
"start_date": "2021-08-01",
|
|
"url": "https://utexas.edu",
|
|
},
|
|
],
|
|
"email": "john@doe.com",
|
|
"extracurricular_activities": [
|
|
{
|
|
"company": "Test Company 1",
|
|
"highlights": [
|
|
"Lead and train members for intercollegiate alpine ski"
|
|
" races in Turkey and organize skiing events."
|
|
],
|
|
"position": "Test Position 1",
|
|
},
|
|
{
|
|
"company": "Test Company 1",
|
|
"date": "Summer 2019 and 2020",
|
|
"highlights": ["Test 1", "Test 2", "Test 3"],
|
|
"location": "Izmir, Turkey",
|
|
"position": "Test Position 1",
|
|
},
|
|
],
|
|
"label": "Engineer at CERN",
|
|
"location": "Geneva, Switzerland",
|
|
"name": "John Doe",
|
|
"personal_projects": [{"name": "Personal Project 1"}],
|
|
"phone": "+905413769286",
|
|
"publications": [
|
|
{
|
|
"authors": [
|
|
"Cetin Yilmaz",
|
|
"Gregory M Hulbert",
|
|
"Noboru Kikuchi",
|
|
],
|
|
"cited_by": 243,
|
|
"date": "2007-08-01",
|
|
"doi": "10.1103/PhysRevB.76.054309",
|
|
"journal": "Physical Review B",
|
|
"title": (
|
|
"Phononic band gaps induced by inertial amplification in"
|
|
" periodic media"
|
|
),
|
|
}
|
|
],
|
|
"section_order": [
|
|
"Education",
|
|
"Work Experience",
|
|
"Academic Projects",
|
|
"Certificates",
|
|
"Personal Projects",
|
|
"Skills",
|
|
"Test Scores",
|
|
"Extracurricular Activities",
|
|
"Publications",
|
|
],
|
|
"skills": [
|
|
{
|
|
"details": "C++, C, Python, JavaScript, MATLAB, Lua, LaTeX",
|
|
"name": "Programming",
|
|
},
|
|
{"details": "GMSH, GetDP, CalculiX", "name": "CAE"},
|
|
],
|
|
"social_networks": [
|
|
{"network": "LinkedIn", "username": "dummy"},
|
|
{"network": "GitHub", "username": "sinaatalay"},
|
|
],
|
|
"test_scores": [
|
|
{"date": "2022-10-01", "details": "120/120", "name": "TOEFL"},
|
|
{
|
|
"details": "9.0/9.0",
|
|
"name": "IELTS",
|
|
"url": "https://example.com",
|
|
},
|
|
],
|
|
"website": "https://example.com",
|
|
"work_experience": [
|
|
{
|
|
"company": "Company 1",
|
|
"end_date": "present",
|
|
"highlights": ["Test 1", "Test 2", "Test 3"],
|
|
"location": "Geneva, Switzerland",
|
|
"position": "Position 1",
|
|
"start_date": "2023-02-01",
|
|
"url": "https://example.com",
|
|
},
|
|
{
|
|
"company": "Company 2",
|
|
"end_date": "2023-02-01",
|
|
"highlights": ["Test 1", "Test 2", "Test 3"],
|
|
"location": "Geneva, Switzerland",
|
|
"position": "Position 2",
|
|
"start_date": "1986-02-01",
|
|
"url": "https://example.com",
|
|
},
|
|
],
|
|
},
|
|
"design": {
|
|
"font": "EBGaramond",
|
|
"options": {
|
|
"date_and_location_width": "3.6 cm",
|
|
"margins": {
|
|
"entry_area": {
|
|
"left": "0.2 cm",
|
|
"right": "0.2 cm",
|
|
"vertical_between": "0.12 cm",
|
|
},
|
|
"highlights_area": {
|
|
"left": "0.6 cm",
|
|
"top": "0.12 cm",
|
|
"vertical_between_bullet_points": "0.07 cm",
|
|
},
|
|
"page": {
|
|
"bottom": "1.35 cm",
|
|
"left": "1.35 cm",
|
|
"right": "1.35 cm",
|
|
"top": "1.35 cm",
|
|
},
|
|
"section_title": {"bottom": "0.13 cm", "top": "0.13 cm"},
|
|
},
|
|
"primary_color": "rgb(0,79,144)",
|
|
"show_last_updated_date": True,
|
|
"show_timespan_in_experience_entries": True,
|
|
},
|
|
"theme": "classic",
|
|
},
|
|
}
|
|
data = data_model.RenderCVDataModel(**test_input) # type: ignore
|
|
output_file_path = rendering.render_template(
|
|
data=data, output_path=os.path.dirname(__file__)
|
|
)
|
|
|
|
# Check if the output file exists:
|
|
self.assertTrue(
|
|
os.path.exists(output_file_path), msg="LaTeX file couldn't be generated."
|
|
)
|
|
|
|
# Compare the output file with the reference file:
|
|
reference_file_path = os.path.join(
|
|
os.path.dirname(__file__), "reference_files", "John_Doe_CV_test.tex"
|
|
)
|
|
with open(output_file_path, "r") as file:
|
|
output = file.read()
|
|
with open(reference_file_path, "r") as file:
|
|
reference = file.read()
|
|
reference = reference.replace("REPLACETHISWITHTODAY", rendering.get_today())
|
|
|
|
self.assertEqual(
|
|
output, reference, msg="LaTeX file didn't match the reference."
|
|
)
|
|
|
|
# Check if the font directory exists:
|
|
output_folder_path = os.path.dirname(output_file_path)
|
|
font_directory_path = os.path.join(output_folder_path, "fonts")
|
|
self.assertTrue(
|
|
os.path.exists(font_directory_path), msg="Font directory doesn't exist."
|
|
)
|
|
|
|
required_files = [
|
|
"EBGaramond-Italic.ttf",
|
|
"EBGaramond-Regular.ttf",
|
|
"EBGaramond-Bold.ttf",
|
|
"EBGaramond-BoldItalic.ttf",
|
|
]
|
|
font_files = os.listdir(font_directory_path)
|
|
for required_file in required_files:
|
|
with self.subTest(required_file=required_file):
|
|
self.assertIn(
|
|
required_file,
|
|
font_files,
|
|
msg=f"Font file ({required_file}) is missing.",
|
|
)
|
|
|
|
# Remove the output directory:
|
|
shutil.rmtree(output_folder_path)
|
|
|
|
def test_run_latex(self):
|
|
latex_file_path = os.path.join(
|
|
os.path.dirname(__file__), "reference_files", "John_Doe_CV_test.tex"
|
|
)
|
|
|
|
with self.subTest(msg="Existent file name"):
|
|
pdf_file = rendering.run_latex(latex_file_path)
|
|
|
|
# Check if the output file exists:
|
|
self.assertTrue(
|
|
os.path.exists(pdf_file), msg="PDF file couldn't be generated."
|
|
)
|
|
|
|
# Compare the pdf file with the reference pdf file:
|
|
reference_pdf_file = pdf_file.replace("_test.pdf", "_reference.pdf")
|
|
reference_pdf_file_size = os.path.getsize(reference_pdf_file)
|
|
pdf_file_size = os.path.getsize(pdf_file)
|
|
ratio = min(reference_pdf_file_size, pdf_file_size) / max(
|
|
reference_pdf_file_size, pdf_file_size
|
|
)
|
|
self.assertTrue(ratio > 0.99, msg="PDF file didn't match the reference.")
|
|
|
|
nonexistent_latex_file_path = os.path.join(
|
|
os.path.dirname(__file__), "reference_files", "nonexistent.tex"
|
|
)
|
|
|
|
with self.subTest(msg="Nonexistent file name"):
|
|
with self.assertRaises(
|
|
FileNotFoundError, msg="File not found error didn't raise."
|
|
):
|
|
rendering.run_latex(nonexistent_latex_file_path)
|
|
|
|
def test_entry_point(self):
|
|
# Change the working directory to the root of the project:
|
|
workspace_path = os.path.dirname(os.path.dirname(__file__))
|
|
|
|
test_input_file_path = os.path.join(
|
|
workspace_path, "tests", "reference_files", "John_Doe_CV_test.yaml"
|
|
)
|
|
subprocess.run(
|
|
[sys.executable, "-m", "rendercv", test_input_file_path],
|
|
check=True,
|
|
)
|
|
|
|
# Read the necessary information and remove the output directory:
|
|
output_file_path = os.path.join(workspace_path, "output", "John_Doe_CV.pdf")
|
|
pdf_file_size = os.path.getsize(output_file_path)
|
|
file_exists = os.path.exists(output_file_path)
|
|
shutil.rmtree(os.path.join(workspace_path, "output"))
|
|
|
|
# Check if the output file exists:
|
|
self.assertTrue(file_exists, msg="PDF file couldn't be generated.")
|
|
|
|
# Compare the pdf file with the reference pdf file:
|
|
reference_pdf_file = os.path.join(
|
|
workspace_path, "tests", "reference_files", "John_Doe_CV_reference.pdf"
|
|
)
|
|
reference_pdf_file_size = os.path.getsize(reference_pdf_file)
|
|
ratio = min(reference_pdf_file_size, pdf_file_size) / max(
|
|
reference_pdf_file_size, pdf_file_size
|
|
)
|
|
self.assertTrue(ratio > 0.99, msg="PDF file didn't match the reference.")
|
|
|
|
# Wrong input:
|
|
with self.subTest(msg="Wrong input"):
|
|
with self.assertRaises(ValueError, msg="Value error didn't raise."):
|
|
subprocess.run(
|
|
[
|
|
sys.executable,
|
|
"-m",
|
|
"rendercv",
|
|
"wrong_input.yaml",
|
|
],
|
|
)
|