Restore the modified project files after testing. (#247)

Revert all the applied patched and restore all the modified files.

JSRemoteTest-DCO-1.0-Signed-off-by: Roland Takacs [email protected]

Author: rtakacs

jstest/__main__.py

@@ -24,6 +24,10 @@
 from jstest import flasher, paths, pseudo_terminal, twisted_server, utils
 
 
+EXIT_SUCCESS = 0
+EXIT_FAILURE = 1
+
+
 def parse_options():
     '''
     Parse the given options.
@@ -210,6 +214,7 @@ def main():
     '''
     user_options = adjust_options(parse_options())
     testresult = TestResult(user_options)
+    exitcode = EXIT_SUCCESS
 
     try:
         # Execute all the jobs defined in the runnable.jobs file.
@@ -230,11 +235,16 @@ def main():
         testresult.upload()
 
     except (Exception, KeyboardInterrupt) as e:
-        jstest.resources.patch_modules(env, revert=True)
-        jstest.console.error('[%s] %s' % (type(e).__name__, str(e)))
-        traceback.print_exc()
+        # Don't print backtrace for keyboard interrupt.
+        if isinstance(e, Exception):
+            traceback.print_exc()
+
+        exitcode = EXIT_FAILURE
+
+    # Revert all the patches and restore all the modified files.
+    jstest.resources.finalize(env)
 
-        sys.exit(1)
+    sys.exit(exitcode)
 
 
 if __name__ == '__main__':

jstest/builder/builder.py

@@ -68,9 +68,7 @@ def __init__(self, env):
             return
 
         # Fetch and configure the modules before build.
-        resources.fetch_modules(env)
-        resources.config_modules(env)
-        resources.patch_modules(env)
+        resources.initialize(env)
 
     def build(self):
         '''
@@ -87,8 +85,6 @@ def build(self):
 
         # Create build information.
         builder_utils.create_build_info(self.env)
-        # Revert all the patches from the projects.
-        resources.patch_modules(self.env, revert=True)
 
     def should_build(self, build_info):
         '''

jstest/common/utils.py

@@ -433,6 +433,41 @@ def is_broken_symlink(path):
     return True
 
 
+def remove(fpath):
+    '''
+    Remove the resource file.
+    '''
+    resource = os.path.normpath(fpath)
+
+    if exists(resource):
+        if os.path.islink(resource):
+            os.unlink(resource)
+
+        elif os.path.isfile(resource):
+            remove_file(resource)
+
+        else:
+            rmtree(resource)
+
+    elif is_broken_symlink(resource):
+        os.unlink(resource)
+
+
+def restore_file(project, fpath):
+    '''
+    Restore the modified project files.
+    '''
+    project_files, _ = execute(project, 'git', ['ls-files'], quiet=True)
+    resource_name = relpath(fpath, project)
+
+    if resource_name in project_files:
+        execute(project, 'git', ['checkout', fpath], quiet=True)
+
+    else:
+        # The file doesn't belong to the project, so that can be removed.
+        remove(fpath)
+
+
 def symlink(src, dst):
     '''
     Create a symlink at dst pointing to src
@@ -445,14 +480,6 @@ def symlink(src, dst):
     dst = os.path.normpath(dst)
 
     # Existing dst needs to be deleted, since symlink requires non-existing dst.
-    if exists(dst):
-        if os.path.islink(dst):
-            os.unlink(dst)
-        elif os.path.isfile(dst):
-            remove_file(dst)
-        else:
-            rmtree(dst)
-    elif is_broken_symlink(dst):
-        os.unlink(dst)
+    remove(dst)
 
     os.symlink(src, dst)

jstest/resources/__init__.py

@@ -33,7 +33,7 @@ def fetch_modules(env):
         utils.execute(module['src'], 'git', ['submodule', 'update', '--init'])
 
 
-def config_modules(env):
+def config_modules(env, revert=False):
     '''
     Configure all the required modules.
     '''
@@ -45,7 +45,11 @@ def config_modules(env):
             if not eval(condition):
                 continue
 
-            utils.symlink(config['src'], config['dst'])
+            if revert:
+                utils.restore_file(module['src'], config['dst'])
+
+            else:
+                utils.symlink(config['src'], config['dst'])
 
 
 def patch_modules(env, revert=False):
@@ -61,14 +65,24 @@ def patch_modules(env, revert=False):
             if not eval(condition):
                 continue
 
-            revertable = patch.get('revert', True)
-            # Note: some patches should not be removed
-            # because sometimes the testing requires the
-            # modifications.
-            if revert and not revertable:
-                continue
-
             # By default, the project is patched. If there is a
             # submodule information, the subproject will be patched.
             project = patch.get('submodule', module['src'])
             utils.patch(project, patch['file'], revert)
+
+
+def initialize(env):
+    '''
+    Public method to initialize the project.
+    '''
+    fetch_modules(env)
+    config_modules(env)
+    patch_modules(env)
+
+
+def finalize(env):
+    '''
+    Public method to restore the project files.
+    '''
+    config_modules(env, revert=True)
+    patch_modules(env, revert=True)

jstest/resources/resources.json

@@ -84,8 +84,7 @@
             "file": "%{patches}/tizenrt-coverage.diff"
           },
           {
-            "file": "%{patches}/tizenrt-openocd.diff",
-            "revert": false
+            "file": "%{patches}/tizenrt-openocd.diff"
           }
         ]
       }
@@ -234,8 +233,7 @@
           {
             "condition": "'%{device}' in ['artik053', 'artik530', 'rpi2'] and %{coverage}",
             "file": "%{patches}/coverage-client.diff",
-            "submodule": "%{iotjs}/deps/jerry/",
-            "revert": false
+            "submodule": "%{iotjs}/deps/jerry/"
           },
           {
             "condition": "'%{device}' in ['artik530', 'rpi2'] and %{memstat}",