class TestCreateTask(HypergolCreateTestCase):
def __init__(self, methodName):
super(TestCreateTask, self).__init__(projectName='TestProject',
methodName=methodName)
self.allPaths = [
Path(self.projectDirectory, 'tasks', 'test_task.py'),
Path(self.projectDirectory, 'tasks'),
Path(self.projectDirectory)
]
self.project = None
self.maxDiff = 10000
def setUp(self):
super().setUp()
self.project = HypergolProject(
projectDirectory=self.projectDirectory,
repoManager=TestRepoManager(raiseIfDirty=False))
self.project.create_project_directory()
self.project.create_tasks_directory()
def test_create_task_creates_files(self):
create_task(className='TestTask',
projectDirectory=self.projectDirectory)
for filePath in self.allPaths:
self.assertEqual(os.path.exists(filePath), True)
def test_create_task_creates_content(self):
content = create_task(className='TestTask',
projectDirectory=self.projectDirectory,
dryrun=True)
self.assertEqual(content[0], TEST_TASK)
def test_create_task_creates_content_source(self):
content = create_task(className='TestSource',
source=True,
projectDirectory=self.projectDirectory,
dryrun=True)
self.assertEqual(content[0], TEST_SOURCE)
def create_project(projectName, dryrun=None, force=None):
"""Generates the project directories and files
Fails if the target directory already exists unless ``force=True`` or ``--force`` in CLI is set.
Directories:
- ``data_models`` with ``__init__.py``
- ``pipelines`` with ``__init__.py``
- ``tasks`` with ``__init__.py``
- ``models`` with ``__init__.py``
- ``models\blocks`` with ``__init__.py``
- ``tests``
Executables:
- ``make_venv.sh`` to create a virtual environment
- ``run_tests.sh`` to run tests
- ``run_pylint.sh`` to run linting
Misc:
- ``requirements.txt``
- ``.gitignore``
- ``README.md``
- ``LICENSE`` <- Don't forget to add current year and your name or change it to the one you want
- ``pylintrc``
Parameters
----------
projectName : string (CamelCase)
Name of the project to be created
dryrun : bool (default=None)
If set to ``True`` it returns the generated code as a string
force : bool (default=None)
If set to ``True`` it overwrites the target file
"""
projectName = NameString(projectName)
project = HypergolProject(projectDirectory=projectName.asSnake,
dryrun=dryrun,
force=force)
project.create_project_directory()
project.create_data_models_directory()
project.render_simple(templateName='__init__.py.j2',
filePath=Path(project.dataModelsPath, '__init__.py'))
project.create_tasks_directory()
project.render_simple(templateName='__init__.py.j2',
filePath=Path(project.tasksPath, '__init__.py'))
project.create_pipelines_directory()
project.render_simple(templateName='__init__.py.j2',
filePath=Path(project.pipelinesPath, '__init__.py'))
project.create_models_directory()
project.render_simple(templateName='__init__.py.j2',
filePath=Path(project.modelsPath, '__init__.py'))
project.create_blocks_directory()
project.render_simple(templateName='__init__.py.j2',
filePath=Path(project.blocksPath, '__init__.py'))
project.create_tests_directory()
makeVenvScript = project.render_executable(templateName='make_venv.sh.j2',
templateData={},
filePath=Path(
project.projectDirectory,
'make_venv.sh'))
runTestScript = project.render_executable(templateName='run_tests.sh.j2',
templateData={},
filePath=Path(
project.projectDirectory,
'run_tests.sh'))
runPylintScript = project.render_executable(
templateName='run_pylint.sh.j2',
templateData={},
filePath=Path(project.projectDirectory, 'run_pylint.sh'))
requirementsContent = project.render_simple(
templateName='requirements.txt.j2',
filePath=Path(project.projectDirectory, 'requirements.txt'))
gitignoreContent = project.render_simple(templateName='.gitignore.j2',
filePath=Path(
project.projectDirectory,
'.gitignore'))
readmeContent = project.render_simple(templateName='README.md.j2',
filePath=Path(
project.projectDirectory,
'README.md'))
licenseContent = project.render_simple(templateName='LICENSE.j2',
filePath=Path(
project.projectDirectory,
'LICENSE'))
pylintrcContent = project.render_simple(templateName='pylintrc.j2',
filePath=Path(
project.projectDirectory,
'pylintrc'))
allContent = (makeVenvScript, runTestScript, runPylintScript,
requirementsContent, gitignoreContent, readmeContent,
licenseContent, pylintrcContent)
return project.cli_final_message(creationType='Project',
name=projectName,
content=allContent)