Server: Updated unit test to ensure deletion of Settings instance

carlosperate · carlosperate · commit 4acb7ab3016f · 2017-05-05T20:38:36.000+01:00
To ensure all tests are independent when run in one go, the
ServerCompilerSettings singleton instance has to be completely dropped on
the class tear down.
diff --git a/ardublocklyserver/compilersettings.py b/ardublocklyserver/compilersettings.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
-#
-# Save and retrieve the compiler settings into a text file.
-#
-# Copyright (c) 2017 carlosperate https://github.com/carlosperate/
-# Licensed under the Apache License, Version 2.0 (the "License"):
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# The ServerCompilerSettings is a singleton class maintains in memory, and
-# writes the Arduino IDE settings into a file.
-# On first invocation of the singleton it reads the settings from the file.
-#
+"""Save and retrieve the compiler settings into a text file.
+
+Copyright (c) 2017 carlosperate https://github.com/carlosperate/
+Licensed under the Apache License, Version 2.0 (the "License"):
+    http://www.apache.org/licenses/LICENSE-2.0
+
+The ServerCompilerSettings is a singleton class maintains in memory, and writes
+the Arduino IDE settings into a file.
+On first invocation of the singleton it reads the settings from the file.
+"""
 from __future__ import unicode_literals, absolute_import, print_function
 import os
 import re
@@ -28,7 +27,7 @@ class ServerCompilerSettings(object):
     The class on first invocation tries to read the settings from the file, it
     keeps them in memory, and every time they are modified the changes are also
     written into the file.
-    No compiler is part of the Python code, instead settings that 
+    No compiler is part of the Python code, instead settings that
     point to the local Arduino IDE and sketch are stored here.
     The public settings to set and get are:
         compiler_dir
@@ -105,8 +104,8 @@ def __initialise(self, settings_dir=None):
         self.__serial_port_key = None
         self.__serial_port_value = None
         if settings_dir:
-            self.__settings_path = os.path.join(
-                settings_dir, self.__settings_filename)
+            self.__settings_path = os.path.join(settings_dir,
+                                                self.__settings_filename)
         else:
             # If not set, the file path will be same location as the executed
             # python code that calls this class
@@ -212,7 +211,7 @@ def set_sketch_name(self, new_sketch_name):
     sketch_name = property(get_sketch_name, set_sketch_name)
 
     def set_sketch_name_default(self):
-         self.__sketch_name = 'ArdublocklySketch'
+        self.__sketch_name = 'ArdublocklySketch'
 
     def set_sketch_name_from_file(self, new_sketch_name):
         """ Only accept letters, numbers, underscores and dashes. """
@@ -546,18 +545,15 @@ def save_settings(self):
 
         # Set the path and create/overwrite the file
         try:
-            settings_file = codecs.open(
-                self.__settings_path, 'wb+', encoding='utf-8')
-            try:
-                settings_parser.write(settings_file)
-                print('Settings file saved to:\n\t%s' % self.__settings_path)
-                sys.stdout.flush()
-            finally:
-                settings_file.close()
+            with codecs.open(self.__settings_path, 'wb+', encoding='utf-8') as\
+                    config_file:
+                settings_parser.write(config_file)
         except Exception as e:
-            print(e)
-            print('Unable to write the settings file to:\n\t%s' %
-                  self.__settings_path)
+            print('%s\nUnable to write the settings file to:\n\t%s' %
+                  (self.__settings_path, str(e)))
+        else:
+            print('Settings file saved to:\n\t%s' % self.__settings_path)
+        sys.stdout.flush()
 
     def read_settings(self):
         """
@@ -600,8 +596,8 @@ def get_settings_file_data(self):
         settings_dict = {}
         settings_parser = configparser.ConfigParser()
         try:
-            settings_parser.read_file(
-                codecs.open(self.__settings_path, 'r', 'utf8'))
+            with codecs.open(self.__settings_path, 'r', 'utf8') as config_file:
+                settings_parser.read_file(config_file)
             settings_dict['arduino_exec_path'] =\
                 settings_parser.get('Arduino_IDE', 'arduino_exec_path')
             settings_dict['arduino_board'] =\
@@ -621,6 +617,12 @@ def get_settings_file_data(self):
             settings_dict = None
         return settings_dict
 
+    def get_settings_file_path(self):
+        return self.__settings_path
+
     def delete_settings_file(self):
+        success = False
         if os.path.exists(self.__settings_path):
             os.remove(self.__settings_path)
+            success = True
+        return success
diff --git a/ardublocklyserver/tests/actions_test.py b/ardublocklyserver/tests/actions_test.py
@@ -7,6 +7,7 @@
 """
 from __future__ import unicode_literals, absolute_import, print_function
 import os
+import gc
 import sys
 import shutil
 import codecs
@@ -47,11 +48,19 @@ def setUpClass(cls):
         if os.path.isdir(cls.temp_folder):
             raise Exception('Directory %s already exists.' % cls.temp_folder)
         os.makedirs(cls.temp_folder)
+        # Create settings file and check it's a new instance by looking at path
         cls.settings = ServerCompilerSettings(cls.temp_folder)
+        if cls.temp_folder not in cls.settings.get_settings_file_path():
+            raise Exception('Settings file not created in temp folder:\n'
+                            '\t%s' % cls.settings.get_settings_file_path())
 
     @classmethod
     def tearDownClass(cls):
         """Deletes the previously created temporary folder."""
+        cls.settings._drop()
+        del cls.settings
+        cls.settings = None
+        gc.collect()
         if os.path.isdir(cls.temp_folder):
             shutil.rmtree(cls.temp_folder)
 
@@ -67,23 +76,6 @@ def tearDown(self):
         if os.path.isdir(self.__class__.temp_folder):
             shutil.rmtree(self.__class__.temp_folder)
 
-    #
-    # Helper functions
-    #
-    def delete_default_settings_file(self):
-        """
-        Checks if there is a settings file in the default location and deletes
-        it if it finds it.
-        This will DELETE a file from the directory this script is called !!!
-        """
-        # Accessing the class static variable does not initialise the singleton
-        settings_file = os.path.normpath(os.path.join(
-            self.temp_folder,
-            ServerCompilerSettings._ServerCompilerSettings__settings_filename))
-        if os.path.exists(settings_file):
-            print('Removing settings file from %s' % settings_file)
-            os.remove(settings_file)
-
     #
     # Command line tests
     #
diff --git a/ardublocklyserver/tests/compilersettings_test.py b/ardublocklyserver/tests/compilersettings_test.py
@@ -1,14 +1,15 @@
 # -*- coding: utf-8 -*-
-#
-# Unit test for the compilersettings module.
-#
-# Copyright (c) 2015 carlosperate https://github.com/carlosperate/
-# Licensed under the Apache License, Version 2.0 (the "License"):
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
+"""Unit test for the ServerCompilerSettings class.
+
+Copyright (c) 2015 carlosperate https://github.com/carlosperate/
+Licensed under the Apache License, Version 2.0 (the "License"):
+    http://www.apache.org/licenses/LICENSE-2.0
+"""
 from __future__ import unicode_literals, absolute_import, print_function
 import os
+import gc
 import sys
+import shutil
 import unittest
 try:
     import mock
@@ -20,47 +21,76 @@
 try:
     from ardublocklyserver.compilersettings import ServerCompilerSettings
 except ImportError:
-    import sys
     file_dir = os.path.dirname(os.path.realpath(__file__))
     package_dir = os.path.dirname(os.path.dirname(file_dir))
     sys.path.insert(0, package_dir)
     from ardublocklyserver.compilersettings import ServerCompilerSettings
 
 
 class ServerCompilerSettingsTestCase(unittest.TestCase):
-    """
-    Tests for ServerCompilerSettings
-    """
+    """Tests for ServerCompilerSettings."""
+
+    settings = None
+    temp_folder = None
+
+    #
+    # Test fixtures
+    #
+    @classmethod
+    def setUpClass(cls):
+        """Create a temporary folder to play round."""
+        cls.temp_folder = os.path.join(
+            os.path.abspath(os.path.dirname(__file__)),
+            'TestTemp_compilersettings')
+        if os.path.isdir(cls.temp_folder):
+            raise Exception('Directory %s already exists.' % cls.temp_folder)
+        os.makedirs(cls.temp_folder)
+        # Create settings file and check it's a new instance by looking at path
+        cls.settings = ServerCompilerSettings(cls.temp_folder)
+        if cls.temp_folder not in cls.settings.get_settings_file_path():
+            raise Exception('Settings file not created in temp folder:\n'
+                            '\t%s' % cls.settings.get_settings_file_path())
+
+    @classmethod
+    def tearDownClass(cls):
+        """Deletes the previously created temporary folder and settings."""
+        cls.settings._drop()
+        del cls.settings
+        cls.settings = None
+        gc.collect()
+        if os.path.isdir(cls.temp_folder):
+            shutil.rmtree(cls.temp_folder)
 
     #
     # Helper functions
     #
     def get_default_settings_file_dir(self):
+        return os.path.normpath(
+            self.settings._ServerCompilerSettings__settings_path)
         # The default location from the ServerCompilerSettings class is the
         # following, so if that changes in the class it needs to change here !!!
-        default_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
+        #default_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
         # Accessing the class static variable does not initialise the singleton
-        return os.path.normpath(os.path.join(
-            default_dir,
-            ServerCompilerSettings._ServerCompilerSettings__settings_filename))
+        #return os.path.normpath(os.path.join(
+        #    default_dir,
+        #    ServerCompilerSettings._ServerCompilerSettings__settings_filename))
 
     def delete_default_settings_file(self):
         """
         Checks if there is a settings file in the default location and deletes
         it if it finds it.
         This will DELETE a file from the directory this script is called !!!
         """
-        settings_file = self.get_default_settings_file_dir()
-        if os.path.exists(settings_file):
-            print('Removing settings file from %s' % settings_file)
-            os.remove(settings_file)
+        print('Removing settings file from %s' % os.path.normpath(
+                self.settings._ServerCompilerSettings__settings_filename))
+        self.settings.delete_settings_file()
 
     def new_ServerCompilerSettings_instance(self):
         """
         Drops the current ServerCompilerSettings instance and creates a new one.
         """
         ServerCompilerSettings()._drop()
-        return ServerCompilerSettings()
+        return ServerCompilerSettings(self.temp_folder)
 
     #
     # Testing the class singleton property
diff --git a/ardublocklyserver/tests/sketchcreator_test.py b/ardublocklyserver/tests/sketchcreator_test.py
@@ -8,6 +8,7 @@
 #
 from __future__ import unicode_literals, absolute_import
 import os
+import gc
 import time
 import codecs
 import shutil
@@ -21,15 +22,17 @@
     package_dir = os.path.dirname(os.path.dirname(file_dir))
     sys.path.insert(0, package_dir)
     from ardublocklyserver import sketchcreator
+from ardublocklyserver.compilersettings import ServerCompilerSettings
 
 
 class SketchCreatorTestCase(unittest.TestCase):
-    """
-    Tests for SketchCreator class.
+    """Tests for SketchCreator class.
+
     Rather than mocking around with os module it creates 'safe' folder inside
     the test directory where it can create and delete files.
     """
 
+    settings = None
     temp_folder = None
 
     #
@@ -48,10 +51,19 @@ def setUpClass(cls):
         cls.default_sketch_path = os.path.join(
             cls.temp_folder, sketchcreator.default_sketch_name,
             '%s.ino' % sketchcreator.default_sketch_name)
+        # Create settings file and check it's a new instance by looking at path
+        cls.settings = ServerCompilerSettings(cls.temp_folder)
+        if cls.temp_folder not in cls.settings.get_settings_file_path():
+            raise Exception('Settings file not created in temp folder:\n'
+                            '\t%s' % cls.settings.get_settings_file_path())
 
     @classmethod
     def tearDownClass(cls):
         """Deletes the previously created temporary folder."""
+        cls.settings._drop()
+        del cls.settings
+        cls.settings = None
+        gc.collect()
         if os.path.isdir(cls.temp_folder):
             shutil.rmtree(cls.temp_folder)
 
