Source code for tests.common.test_file_handler

# !/usr/bin/python
# -*- coding: utf-8 -*-
"""test class"""
import filecmp
import os
import tempfile
import unittest

from plasoscaffolder.common import file_handler


class FileHandlerTest(unittest.TestCase):
  """ Class representing the test case testing the file file_handler class"""
  name = "__testfile"
  suffix = "py"
  file = '{0:s}.{1:s}'.format(name, suffix)

  def testCreateFolder(self):
    """Tests if the creation of a folder works."""
    with tempfile.TemporaryDirectory() as tmpdir:
      new_path = os.path.join(tmpdir, "newfolder")
      self.assertFalse(os.path.exists(new_path))
      handler = file_handler.FileHandler()
      handler._CreateFolder(new_path)  # pylint: disable=W0212
      actual = os.path.exists(new_path)
    self.assertTrue(actual)

  def testCreateFilePath(self):
    """Tests if the construction of the folder path works."""
    with tempfile.TemporaryDirectory() as tmpdir:
      new_path = os.path.join(tmpdir, "temp")
      path = file_handler.FileHandler.CreateFilePath(new_path,
                                                     self.name,
                                                     self.suffix)
      self.assertEqual(path, os.path.join(new_path, self.file))

  def testCreateFile(self):
    """Tests if the creation of a file none existing beforehand works."""
    with tempfile.TemporaryDirectory() as tmpdir:
      handler = file_handler.FileHandler()
      file_path = os.path.join(tmpdir, self.file)
      self.assertFalse(os.path.exists(file_path))
      handler.CreateFile(tmpdir, self.name, self.suffix)
      self.assertTrue(os.path.exists(file_path))

  def testCreateFileIfPathNotExisting(self):
    """Tests if the creation of a file, none existing beforehand and folder
    not existing, works."""
    with tempfile.TemporaryDirectory() as tmpdir:
      new_path = os.path.join(tmpdir, "temp")
      handler = file_handler.FileHandler()
      file_path = os.path.join(new_path, self.file)
      self.assertFalse(os.path.exists(file_path))
      handler.CreateFile(new_path, self.name, self.suffix)
      self.assertTrue(os.path.exists(file_path))

  def testCreateFileFromPath(self):
    """Tests if the creation of a file none existing beforhand works."""
    handler = file_handler.FileHandler()
    with tempfile.TemporaryDirectory() as tmpdir:
      source = os.path.join(tmpdir, self.file)
      self.assertFalse(os.path.exists(source))
      handler.CreateFileFromPath(source)
      self.assertTrue(os.path.exists(source))

  def testCopyFile(self):
    """Tests if the copying of a file none existing beforhand works."""
    expected_content = "this is test content."

    with tempfile.TemporaryDirectory() as tmpdir:
      source = os.path.join(tmpdir, self.file)
      destination = os.path.join(tmpdir, "copy", self.file)

      with open(source, "a") as f:
        f.write(expected_content)

      handler = file_handler.FileHandler()
      self.assertFalse(os.path.exists(destination))
      handler.CopyFile(source, destination)
      self.assertTrue(os.path.exists(destination))
      self.assertTrue(filecmp.cmp(destination, source))

  def testAddContentIfFileExists(self):
    """Tests if the editing of a file existing works."""
    content = "this is test content. "
    expected = content + content

    with tempfile.TemporaryDirectory() as tmpdir:
      source = os.path.join(tmpdir, self.file)
      with open(source, "a") as f:
        f.write(content)

      handler = file_handler.FileHandler()
      self.assertTrue(os.path.exists(source))
      handler.AddContent(source, content)
      self.assertTrue(os.path.exists(source))

      with open(source, "r") as f:
        actual = f.read()

    self.assertEqual(expected, actual)

  def testAddContentIfFileDoesNotExist(self):
    """Tests if the editing of a file not existing works."""
    content = "this is test content. "
    expected = content

    with tempfile.TemporaryDirectory() as tmpdir:
      source = os.path.join(tmpdir, self.file)
      handler = file_handler.FileHandler()
      self.assertFalse(os.path.exists(source))
      handler.AddContent(source, content)
      self.assertTrue(os.path.exists(source))

      with open(source, "r") as f:
        actual = f.read()

    self.assertEqual(expected, actual)

  def testCreateOrModifyFileWithContentIfFileExists(self):
    """Tests if the method create or modify file with content works, if the
    file exists"""
    content = "this is test content. "
    expected = content + content

    with tempfile.TemporaryDirectory() as tmpdir:
      source = os.path.join(tmpdir, self.file)
      with open(source, "a") as f:
        f.write(content)

      handler = file_handler.FileHandler()
      self.assertTrue(os.path.exists(source))
      handler.CreateOrModifyFileWithContent(source, content)
      self.assertTrue(os.path.exists(source))

      with open(source, "r") as f:
        actual = f.read()

    self.assertEqual(expected, actual)

  def testAddContentIfFileAndFolderDoesNotExist(self):
    """Tests if the method create or modify file with content works, if the
    file and Folder does not exist"""
    content = "this is test content. "
    expected = content

    with tempfile.TemporaryDirectory() as tmpdir:
      new_path = os.path.join(tmpdir, "newfolder")
      source = os.path.join(new_path, self.file)
      handler = file_handler.FileHandler()
      self.assertFalse(os.path.exists(source))
      handler.CreateOrModifyFileWithContent(source, content)
      self.assertTrue(os.path.exists(source))

      with open(source, "r") as f:
        actual = f.read()

    self.assertEqual(expected, actual)


if __name__ == '__main__':
  unittest.main()