add keywords for copying files to notebook dir

Author: bollwyvl

atest/acceptance/01_server/00_basic.robot

@@ -2,6 +2,7 @@
 Test Teardown     Terminate All Processes
 Library           JupyterLibrary
 Library           Process
+Library           OperatingSystem
 
 *** Test Cases ***
 Start one server
@@ -29,3 +30,17 @@ Start three servers
     Should Not Contain    ${log3}    The Jupyter Notebook is running    msg=Unawaited server log should not contain expected status message
     ${terminated} =    Terminate All Jupyter Servers
     Should be equal as integers    ${terminated}    0    msg=No servers should have been terminated
+
+Notebook Files
+    [Setup]    Create File    ${OUTPUT_DIR}${/}foo.txt    bar
+    ${nb1} =    Start New Jupyter Server
+    Copy Files to Jupyter Directory    ${OUTPUT_DIR}${/}*.txt
+    ${nbdir} =    Get Jupyter Directory    ${nb1}
+    ${out} =    Get File    ${nbdir}${/}foo.txt
+    Should Be Equal    ${out}    bar
+    Copy Files from Jupyter Directory    foo.txt    ${OUTPUT_DIR}
+    Terminate All Jupyter Servers
+    ${out} =    Get File    ${OUTPUT_DIR}${/}foo.txt
+    Should Be Equal    ${out}    bar
+    File Should Not Exist    ${nbdir}${/}foo.txt
+    [Teardown]    Remove File    ${OUTPUT_DIR}${/}foo.txt

src/JupyterLibrary/keywords/server.py

@@ -14,38 +14,78 @@
 class ServerKeywords(LibraryComponent):
     _nbserver_handles = []
     _nbserver_tmpdirs = {}
+    _nbserver_notebook_dirs = {}
 
     @keyword
     def start_new_jupyter_server(self, command="jupyter", *arguments, **configuration):
         """ Start a Jupyter server
+
+            If not configured, the HOME environment variable and current
+            working directory will be set to avoid leaking configuration
+            between between runs (or the test instance) itself. These
+            directories will be cleaned up after the server process is
+            terminated.
         """
         plib = BuiltIn().get_library_instance("Process")
         if not arguments:
             arguments = self.build_jupyter_server_arguments()
 
         tmpdir = tempfile.mkdtemp()
 
-        if "--notebook-dir" not in arguments:
-            notebook_dir = join(tmpdir, "notebooks")
-            os.mkdir(notebook_dir)
-            arguments += ["--notebook-dir", notebook_dir]
-
         if "env:HOME" not in configuration:
             home_dir = join(tmpdir, "home")
             os.mkdir(home_dir)
             configuration["env:HOME"] = home_dir
 
+        notebook_dir = configuration.get("cwd")
+        if notebook_dir is None:
+            notebook_dir = join(tmpdir, "notebooks")
+            os.mkdir(notebook_dir)
+            configuration["cwd"] = notebook_dir
+
         handle = plib.start_process("jupyter", *arguments, **configuration)
 
         self._nbserver_handles += [handle]
         self._nbserver_tmpdirs[handle] = tmpdir
+        self._nbserver_notebook_dirs[handle] = notebook_dir
 
         return handle
 
     @keyword
     def build_jupyter_server_arguments(self):
+        """ Some default jupyter arguments
+        """
         return ["notebook", "--no-browser"]
 
+    @keyword
+    def copy_files_to_jupyter_directory(self, *sources, **kwargs):
+        """ Copy some files into the (temporary) jupyter server root
+        """
+        nbserver = kwargs.get("nbserver", self._nbserver_handles[-1])
+        notebook_dir = self._nbserver_notebook_dirs[nbserver]
+        BuiltIn().import_library("OperatingSystem")
+        osli = BuiltIn().get_library_instance("OperatingSystem")
+        osli.copy_files(*(list(sources) + [notebook_dir]))
+
+    @keyword
+    def copy_files_from_jupyter_directory(self, *sources_and_destinations, **kwargs):
+        """ Copy some files from the (temporary) jupyter server root
+
+            Patterns will have the notebook directory prepended
+        """
+        nbserver = kwargs.get("nbserver", self._nbserver_handles[-1])
+        notebook_dir = self._nbserver_notebook_dirs[nbserver]
+        BuiltIn().import_library("OperatingSystem")
+        osli = BuiltIn().get_library_instance("OperatingSystem")
+        sources = [join(notebook_dir, src) for src in sources_and_destinations[:-1]]
+        dest = sources_and_destinations[-1]
+        osli.copy_files(*sources + [dest])
+
+    @keyword
+    def get_jupyter_directory(self, nbserver=None):
+        nbserver = nbserver if nbserver is not None else self._nbserver_handles[-1]
+        return self._nbserver_notebook_dirs[nbserver]
+
     @keyword
     def wait_for_jupyter_server_to_be_ready(self, *nbservers, **kwargs):
         """  Wait for the most-recently started Jupyter server to be ready