eyhc
/
rendercv
mirror of https://github.com/eyhc1/rendercv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update tests

This commit is contained in:
Sina Atalay 2023-11-18 16:25:20 +01:00 committed by Jeffrey Goldberg
parent e807ca4268
commit e06261ba4a
3 changed files with 70 additions and 420 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

356
tests/reference_files/John_Doe_CV_test.tex
View File

@ -1,356 +0,0 @@
\documentclass[10pt, a4paper]{article}
% Packages:
\usepackage[
ignoreheadfoot, % set margins without considering header and footer
top=1.35 cm, % seperation between body and page edge from the top
bottom=1.35 cm, % seperation between body and page edge from the bottom
left=1.35 cm, % seperation between body and page edge from the left
right=1.35 cm, % seperation between body and page edge from the right
% showframe % for debugging
]{geometry} % for adjusting page geometry
\usepackage{fontspec} % for loading fonts
\usepackage[explicit]{titlesec} % for customizing section titles
\usepackage{tabularx} % for making tables with fixed width columns
\usepackage{array} % tabularx requires this
\usepackage[dvipsnames]{xcolor} % for coloring text
\definecolor{primaryColor}{RGB}{0, 79, 144} % define primary color
\usepackage{enumitem} % for customizing lists
\usepackage{fontawesome5} % for using icons
\usepackage[
pdftitle={John Doe's CV},
pdfauthor={John Doe},
colorlinks=true,
urlcolor=primaryColor
]{hyperref} % for links, metadata and bookmarks
\usepackage[pscoord]{eso-pic} % for floating text on the page
\usepackage{calc} % for calculating lengths
% Some settings:
\pagestyle{empty} % no header or footer
\setcounter{secnumdepth}{0} % no section numbering
\setlength{\parindent}{0pt} % no indentation
\setlength{\topskip}{0pt} % no top skip
\pagenumbering{gobble} % no page numbering
\setmainfont{EBGaramond}[
Path= fonts/,
Extension = .ttf,
UprightFont = *-Regular,
ItalicFont = *-Italic,
BoldFont = *-Bold,
BoldItalicFont = *-BoldItalic
]
\titleformat{\section}{
% make the font size of the section title large and color it with the primary color
\Large\color{primaryColor}
}{
}{
}{
% print bold title, give 0.15 cm space and draw a line of 0.8 pt thickness
% from the end of the title to the end of the body
\textbf{#1}\hspace{0.15cm}\titlerule[0.8pt]\hspace{-0.1cm}
}[] % section title formatting
\titlespacing{\section}{
% left space:
0pt
}{
% top space:
0.13 cm
}{
% bottom space:
0.13 cm
} % section title spacing
\newcolumntype{L}[1]{
>{\raggedright\let\newline\\\arraybackslash\hspace{0pt}}p{#1}
} % left-aligned fixed width column type
\newcolumntype{R}[1]{
>{\raggedleft\let\newline\\\arraybackslash\hspace{0pt}}p{#1}
} % right-aligned fixed width column type
\newcolumntype{K}[1]{
>{\let\newline\\\arraybackslash\hspace{0pt}}X
} % left-aligned (but justified) flexible width column type
\setlength\tabcolsep{-1.5pt} % no space between columns
\newenvironment{highlights}{
\begin{itemize}[
topsep=0pt,
parsep=0.07 cm,
partopsep=0pt,
itemsep=0pt,
after=\vspace*{-1\baselineskip},
leftmargin=0.6 cm + 3pt
]
}{
\end{itemize}
} % new environment for highlights
\newenvironment{header}{
\setlength{\topsep}{0pt}\par\kern\topsep\centering\color{primaryColor}\linespread{1.5}
}{
\par\kern\topsep
} % new environment for the header
\newcommand{\placelastupdatedtext}{% \placetextbox{<horizontal pos>}{<vertical pos>}{<stuff>}
\AddToShipoutPictureFG*{% Add <stuff> to current page foreground
\put(
\LenToUnit{\paperwidth-1.35 cm-0.2 cm+0.05cm},
\LenToUnit{\paperheight-0.675 cm}
){\vtop{{\null}\makebox[0pt][c]{
\small\color{gray}\emph{Last updated on REPLACETHISWITHTODAY}\hspace{\widthof{Last updated on REPLACETHISWITHTODAY}}
}}}%
}%
}%
% save the original href command in a new command:
\let\hrefWithoutArrow\href
% new command for external links:
\renewcommand{\href}[2]{\hrefWithoutArrow{#1}{#2\, \raisebox{.1ex}{\footnotesize \faExternalLink*}}}
\begin{document}
\placelastupdatedtext
\begin{header}
\Huge
\textbf{John Doe}
\normalsize
\mbox{{\small\faMapMarker*}\hspace{0.13cm}Geneva, Switzerland}
\hspace{0.5cm}
\mbox{\hrefWithoutArrow{tel:+905413769286}{{\footnotesize\faPhone*}\hspace{0.13cm}+90 541 376 92 86}}
\hspace{0.5cm}
\mbox{\hrefWithoutArrow{mailto:john@doe.com}{{\small\faEnvelope[regular]}\hspace{0.13cm}john@doe.com}}
\hspace{0.5cm}
\mbox{\hrefWithoutArrow{https://example.com/}{{\small\faLink}\hspace{0.13cm}example.com}}
\hspace{0.5cm}
\mbox{\hrefWithoutArrow{https://www.linkedin.com/in/dummy}{{\small\faLinkedinIn}\hspace{0.13cm}dummy}}
\hspace{0.5cm}
\mbox{\hrefWithoutArrow{https://www.github.com/sinaatalay}{{\small\faGithub}\hspace{0.13cm}sinaatalay}}
\end{header}
\centering
\section{Education}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{L{0.85cm} K{0.2 cm} R{3.6 cm}}
\textbf{BS}
&
\textbf{Bogazici University}, Mechanical Engineering
\vspace*{0.12 cm}
\begin{highlights}
\item GPA: 3.80/4.00 (\href{https://example.com/}{Transcript})
\item Test 1
\item Test 2
\end{highlights}
&
Istanbul, Turkey \newline
Sept. 1980 to Jan. 1985
\end{tabularx}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{L{0.85cm} K{0.2 cm} R{3.6 cm}}
\textbf{}
&
\textbf{The University of Texas at Austin}, Mechanical Engineering, Student Exchange Program
\vspace*{0.12 cm}
&
Austin, TX, USA \newline
Aug. 2021 to Jan. 2022
\end{tabularx}
\section{Work Experience}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Company 1}, Position 1
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\item Test 3
\end{highlights}
&
Geneva, Switzerland \newline
Feb. 2023 to present
\end{tabularx}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Company 2}, Position 2
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\item Test 3
\end{highlights}
&
Geneva, Switzerland \newline
Feb. 1986 to Feb. 2023
\end{tabularx}
\section{Academic Projects}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Academic Project 1}, \href{https://example.com/}{view on my website}
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\end{highlights}
&
Istanbul, Turkey \newline
Spring 2022
\end{tabularx}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm}}
\textbf{Academic Project 2}, \href{https://example.com/}{view on my website}
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\end{highlights}
\end{tabularx}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Academic Project 3}, \href{https://example.com/}{view on my website}
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\end{highlights}
&
Istanbul, Turkey \newline
Feb. 2022 to May 2022
\end{tabularx}
\section{Certificates}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm}}
\textbf{Certificate 1}
\vspace*{0.12 cm}
\end{tabularx}
\section{Personal Projects}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm}}
\textbf{Personal Project 1}
\vspace*{0.12 cm}
\end{tabularx}
\section{Skills}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
\textbf{Programming:} C++, C, Python, JavaScript, MATLAB, Lua, LaTeX
\par\endgroup
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
\textbf{CAE:} GMSH, GetDP, CalculiX
\par\endgroup
\section{Test Scores}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
\textbf{TOEFL:} 120/120
\par\endgroup
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
\textbf{IELTS:} 9.0/9.0 (\href{https://example.com/}{Score Report})
\par\endgroup
\section{Extracurricular Activities}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Test Company 1}, Test Position 1
\vspace*{0.12 cm}
\begin{highlights}
\item Lead and train members for intercollegiate alpine ski races in Turkey and organize skiing events.
\end{highlights}
&
\end{tabularx}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Test Company 1}, Test Position 1
\vspace*{0.12 cm}
\begin{highlights}
\item Test 1
\item Test 2
\item Test 3
\end{highlights}
&
Izmir, Turkey \newline
Summer 2019 and 2020
\end{tabularx}
\section{Publications}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Phononic band gaps induced by inertial amplification in periodic media}
\vspace{0.06 cm}
C. Yilmaz, G. M. Hulbert, N. Kikuchi
\vspace{0.06 cm}
DOI: \href{https://doi.org/10.1103/PhysRevB.76.054309}{10.1103/PhysRevB.76.054309}
&
Aug. 2007
\end{tabularx}
\end{document}

92
tests/reference_files/John_Doe_CV_tex_reference.tex
View File

@ -81,16 +81,17 @@
>{\raggedleft\let\newline\\\arraybackslash\hspace{0pt}}p{#1}
} % right-aligned fixed width column type
\newcolumntype{K}[1]{
>{\raggedright\let\newline\\\arraybackslash\hspace{0pt}}X
} % left-aligned flexible width column type
>{\let\newline\\\arraybackslash\hspace{0pt}}X
} % left-aligned (but justified) flexible width column type
\setlength\tabcolsep{-1.5pt} % no space between columns
\newenvironment{highlights}{
\begin{itemize}[
topsep=0pt,
parsep=0.07 cm,
partopsep=0pt,
itemsep=0pt,
after=\vspace{-1\baselineskip},
after=\vspace*{-1\baselineskip},
leftmargin=0.6 cm + 3pt
]
}{
@ -109,7 +110,7 @@
\LenToUnit{\paperwidth-1.35 cm-0.2 cm+0.05cm},
\LenToUnit{\paperheight-0.675 cm}
){\vtop{{\null}\makebox[0pt][c]{
\small\color{gray}\textit{Last updated on REPLACETHISWITHTODAY}\hspace{\widthof{Last updated on REPLACETHISWITHTODAY}}
\small\color{gray}\textit{Last updated on November 18, 2023}\hspace{\widthof{Last updated on November 18, 2023}}
}}}%
}%
}%
@ -123,11 +124,9 @@
\placelastupdatedtext
\begin{header}
\fontsize{30 pt}{30 pt}
\Huge
\textbf{John Doe}
\vspace{0.2 cm}
\normalsize
\mbox{{\small\faMapMarker*}\hspace{0.13cm}TX, USA}
\hspace{0.5cm}
@ -142,12 +141,8 @@
\mbox{\hrefWithoutArrow{https://www.linkedin.com/in/johndoe}{{\small\faLinkedinIn}\hspace{0.13cm}johndoe}}
\end{header}
\vspace{0.2 cm}
\section{Summary}
{
\raggedright
\setlength{\leftskip}{0.2 cm}
\setlength{\rightskip}{0.2 cm}
@ -155,7 +150,6 @@
\setlength{\leftskip}{0cm}
\setlength{\rightskip}{0cm}
}
\centering
\section{Education}
@ -164,7 +158,7 @@
\textbf{BS}
&
\textbf{My University}, Mechanical Engineering
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item GPA: 3.99/4.00 (\href{https://example.com/}{Transcript})
\item Class rank: 1 of 62 \hspace*{-0.2cm}
@ -174,12 +168,13 @@
Sept. 2017 to Jan. 2023
\end{tabularx}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{L{0.85cm} K{0.2 cm} R{3.6 cm}}
\textbf{}
&
\textbf{The University of Texas at Austin}, Mechanical Engineering, Student Exchange Program
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item GPA: 4.00/4.00 (\href{https://example.com/}{Transcript}) \hspace*{-0.2cm}
\end{highlights}
@ -194,7 +189,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{CERN}, Mechanical Engineer
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item CERN is a research organization that operates the world's largest and most powerful particle accelerator.
\item Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
@ -206,10 +201,11 @@
10 months
\end{tabularx}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{AmIACompany}, Summer Intern
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item AmIACompany is a technology company that provides web-based engineering applications that enable the simulation and optimization of products and manufacturing tools.
\item Modeled and simulated a metal-forming process deep drawing using finite element analysis with open-source software called CalculiX. \hspace*{-0.2cm}
@ -226,7 +222,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Design and Construction of a Robot}, \href{https://example.com/}{view on my website}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item Designed and constructed a controllable robot that measures a car's torque and power output at different speeds for my senior design project. \hspace*{-0.2cm}
\end{highlights}
@ -235,10 +231,11 @@
Fall 2022
\end{tabularx}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Design and Construction of an Another Robot}, \href{https://example.com/}{view on my website}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item Designed, built, and programmed a microcontroller-based device that plays a guitar with DC motors as part of a mechatronics course term project. \hspace*{-0.2cm}
\end{highlights}
@ -253,7 +250,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Machine Learning by Stanford University}, \href{https://example.com/}{Certificate}
\vspace{0.12 cm}
\vspace*{0.12 cm}
&
Sept. 2022
\end{tabularx}
@ -264,7 +261,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Ray Tracing in C++}, \href{https://example.com/}{view on my website}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item Coded a ray tracer in C++ that can render scenes with multiple light sources, spheres, and planes with reflection and refraction properties. \hspace*{-0.2cm}
\end{highlights}
@ -276,7 +273,8 @@
\section{Skills}
\begingroup\raggedright \leftskip=0.2 cm
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -284,8 +282,10 @@
\par\endgroup
\vspace{0.12 cm}
\begingroup\raggedright \leftskip=0.2 cm
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -293,8 +293,10 @@
\par\endgroup
\vspace{0.12 cm}
\begingroup\raggedright \leftskip=0.2 cm
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -302,8 +304,10 @@
\par\endgroup
\vspace{0.12 cm}
\begingroup\raggedright \leftskip=0.2 cm
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -315,7 +319,8 @@
\section{Test Scores}
\begingroup\raggedright \leftskip=0.2 cm
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -323,8 +328,10 @@
\par\endgroup
\vspace{0.12 cm}
\begingroup\raggedright \leftskip=0.2 cm
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -338,7 +345,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Dumanlikiz Skiing Club}, Co-founder / Skiing Instructor
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item Taught skiing during winters as a certified skiing instructor. \hspace*{-0.2cm}
\end{highlights}
@ -370,7 +377,8 @@
\section{My Custom Section}
\begingroup\raggedright \leftskip=0.2 cm
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -378,8 +386,10 @@
\par\endgroup
\vspace{0.12 cm}
\begingroup\raggedright \leftskip=0.2 cm
\vspace*{0.12 cm}
\begingroup\raggedright
\leftskip=0.2 cm
\advance\csname @rightskip\endcsname 0.2 cm
\advance\rightskip 0.2 cm
@ -395,7 +405,7 @@
\textbf{HA}
&
\textbf{Hop!}, Hop!
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item There are only five types of entries: \textit{EducationEntry}, \textit{ExperienceEntry}, \textit{NormalEntry}, \textit{OneLineEntry}, and \textit{PublicationEntry}.
\item This is an EducationEntry! \hspace*{-0.2cm}
@ -411,7 +421,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm} R{3.6 cm}}
\textbf{Hop!}, Hop!
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item I think this is really working. This is an \textit{ExperienceEntry}! \hspace*{-0.2cm}
\end{highlights}
@ -426,7 +436,7 @@
\begin{tabularx}{\textwidth-0.4 cm-0.13cm}{K{0.2 cm}}
\textbf{This is a normal entry!}, \href{https://example.com/}{My Link Text}
\vspace{0.12 cm}
\vspace*{0.12 cm}
\begin{highlights}
\item You don't have to specify a \textit{date} or \textbf{location} every time.
\item You can use \textit{Markdown} in the \textbf{highlights}!

42
tests/test_cli.py
View File

@ -12,17 +12,16 @@ class TestCLI(unittest.TestCase):
# Change the working directory to the root of the project:
workspace_path = os.path.dirname(os.path.dirname(__file__))
with self.subTest(msg="Correct input"):
test_input_file_path = os.path.join(
workspace_path,
"tests",
"reference_files",
"John_Doe_CV_yaml_reference.yaml",
)
subprocess.run(
[sys.executable, "-m", "rendercv", "render", test_input_file_path],
check=True,
)
test_input_file_path = os.path.join(
workspace_path,
"tests",
"reference_files",
"John_Doe_CV_yaml_reference.yaml",
)
subprocess.run(
[sys.executable, "-m", "rendercv", "render", 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")
@ -33,18 +32,15 @@ class TestCLI(unittest.TestCase):
# 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_pdf_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.98, msg="PDF file didn't match the reference.")
# Compare the pdf file with the reference pdf file:
reference_pdf_file = os.path.join(
workspace_path, "tests", "reference_files", "John_Doe_CV_pdf_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.98, msg="PDF file didn't match the reference.")
# Wrong input:
with self.subTest(msg="Wrong input"):