From c166a05f5d7ae2ff57dd08e435123abdd9ba9144 Mon Sep 17 00:00:00 2001 From: Min RK Date: Mon, 8 Dec 2014 17:37:00 -0800 Subject: [PATCH] abstract some methods in contents service tests should allow re-use for ContentsManager subclasses --- .../contents/tests/test_contents_api.py | 85 +++++++++++-------- .../services/contents/tests/test_manager.py | 37 ++++---- IPython/html/tests/launchnotebook.py | 2 + 3 files changed, 74 insertions(+), 50 deletions(-) diff --git a/IPython/html/services/contents/tests/test_contents_api.py b/IPython/html/services/contents/tests/test_contents_api.py index efee0b19e..5628641af 100644 --- a/IPython/html/services/contents/tests/test_contents_api.py +++ b/IPython/html/services/contents/tests/test_contents_api.py @@ -12,7 +12,7 @@ pjoin = os.path.join import requests -from IPython.html.utils import url_path_join, url_escape +from IPython.html.utils import url_path_join, url_escape, to_os_path from IPython.html.tests.launchnotebook import NotebookTestBase, assert_http_error from IPython.nbformat import read, write, from_dict from IPython.nbformat.v4 import ( @@ -73,9 +73,6 @@ class API(object): def upload(self, path, body): return self._req('PUT', path, body) - def mkdir_untitled(self, path='/'): - return self._req('POST', path, json.dumps({'type': 'directory'})) - def mkdir(self, path='/'): return self._req('PUT', path, json.dumps({'type': 'directory'})) @@ -133,33 +130,62 @@ class APITest(NotebookTestBase): @staticmethod def _txt_for_name(name): return u'%s text file' % name - + + def to_os_path(self, api_path): + return to_os_path(api_path, root=self.notebook_dir.name) + + def make_dir(self, api_path): + """Create a directory at api_path""" + os_path = self.to_os_path(api_path) + try: + os.makedirs(os_path) + except OSError: + print("Directory already exists: %r" % os_path) + + def make_txt(self, api_path, txt): + """Make a text file at a given api_path""" + os_path = self.to_os_path(api_path) + with io.open(os_path, 'w', encoding='utf-8') as f: + f.write(txt) + + def make_blob(self, api_path, blob): + """Make a binary file at a given api_path""" + os_path = self.to_os_path(api_path) + with io.open(os_path, 'wb') as f: + f.write(blob) + + def make_nb(self, api_path, nb): + """Make a notebook file at a given api_path""" + os_path = self.to_os_path(api_path) + + with io.open(os_path, 'w', encoding='utf-8') as f: + write(nb, f, version=4) + + def isfile(self, api_path): + return os.path.isfile(self.to_os_path(api_path)) + + def isdir(self, api_path): + return os.path.isdir(self.to_os_path(api_path)) + def setUp(self): - nbdir = self.notebook_dir.name self.blob = os.urandom(100) self.b64_blob = base64.encodestring(self.blob).decode('ascii') for d in (self.dirs + self.hidden_dirs): - d.replace('/', os.sep) - if not os.path.isdir(pjoin(nbdir, d)): - os.mkdir(pjoin(nbdir, d)) + self.make_dir(d) for d, name in self.dirs_nbs: - d = d.replace('/', os.sep) # create a notebook - with io.open(pjoin(nbdir, d, '%s.ipynb' % name), 'w', - encoding='utf-8') as f: - nb = new_notebook() - write(nb, f, version=4) - + nb = new_notebook() + self.make_nb(u'{}/{}.ipynb'.format(d, name), nb) + # create a text file - with io.open(pjoin(nbdir, d, '%s.txt' % name), 'w', - encoding='utf-8') as f: - f.write(self._txt_for_name(name)) - + txt = self._txt_for_name(name) + self.make_txt(u'{}/{}.txt'.format(d, name), txt) + # create a binary file - with io.open(pjoin(nbdir, d, '%s.blob' % name), 'wb') as f: - f.write(self._blob_for_name(name)) + blob = self._blob_for_name(name) + self.make_blob(u'{}/{}.blob'.format(d, name), blob) self.api = API(self.base_url()) @@ -204,11 +230,8 @@ class APITest(NotebookTestBase): self.assertEqual(nbnames, expected) def test_list_dirs(self): - print(self.api.list().json()) dirs = dirs_only(self.api.list().json()) dir_names = {normalize('NFC', d['name']) for d in dirs} - print(dir_names) - print(self.top_level_dirs) self.assertEqual(dir_names, self.top_level_dirs) # Excluding hidden dirs def test_list_nonexistant_dir(self): @@ -283,11 +306,8 @@ class APITest(NotebookTestBase): self.assertEqual(rjson['name'], path.rsplit('/', 1)[-1]) self.assertEqual(rjson['path'], path) self.assertEqual(rjson['type'], type) - isright = os.path.isdir if type == 'directory' else os.path.isfile - assert isright(pjoin( - self.notebook_dir.name, - path.replace('/', os.sep), - )) + isright = self.isdir if type == 'directory' else self.isfile + assert isright(path) def test_create_untitled(self): resp = self.api.create_untitled(path=u'å b') @@ -451,7 +471,7 @@ class APITest(NotebookTestBase): self.assertEqual(resp.headers['Location'].split('/')[-1], 'z.ipynb') self.assertEqual(resp.json()['name'], 'z.ipynb') self.assertEqual(resp.json()['path'], 'foo/z.ipynb') - assert os.path.isfile(pjoin(self.notebook_dir.name, 'foo', 'z.ipynb')) + assert self.isfile('foo/z.ipynb') nbs = notebooks_only(self.api.list('foo').json()) nbnames = set(n['name'] for n in nbs) @@ -471,11 +491,6 @@ class APITest(NotebookTestBase): nbmodel= {'content': nb, 'type': 'notebook'} resp = self.api.save('foo/a.ipynb', body=json.dumps(nbmodel)) - nbfile = pjoin(self.notebook_dir.name, 'foo', 'a.ipynb') - with io.open(nbfile, 'r', encoding='utf-8') as f: - newnb = read(f, as_version=4) - self.assertEqual(newnb.cells[0].source, - u'Created by test ³') nbcontent = self.api.read('foo/a.ipynb').json()['content'] newnb = from_dict(nbcontent) self.assertEqual(newnb.cells[0].source, diff --git a/IPython/html/services/contents/tests/test_manager.py b/IPython/html/services/contents/tests/test_manager.py index 0cdec6b3a..45f6f4f51 100644 --- a/IPython/html/services/contents/tests/test_manager.py +++ b/IPython/html/services/contents/tests/test_manager.py @@ -2,7 +2,6 @@ """Tests for the notebook manager.""" from __future__ import print_function -import logging import os from tornado.web import HTTPError @@ -17,7 +16,6 @@ from IPython.html.utils import url_path_join from IPython.testing import decorators as dec from ..filemanager import FileContentsManager -from ..manager import ContentsManager class TestFileContentsManager(TestCase): @@ -72,7 +70,7 @@ class TestFileContentsManager(TestCase): class TestContentsManager(TestCase): - + def setUp(self): self._temp_dir = TemporaryDirectory() self.td = self._temp_dir.name @@ -83,15 +81,25 @@ class TestContentsManager(TestCase): def tearDown(self): self._temp_dir.cleanup() - def make_dir(self, abs_path, rel_path): + def make_dir(self, api_path): """make subdirectory, rel_path is the relative path to that directory from the location where the server started""" - os_path = os.path.join(abs_path, rel_path) + os_path = self.contents_manager._get_os_path(api_path) try: os.makedirs(os_path) except OSError: print("Directory already exists: %r" % os_path) - return os_path + + def symlink(self, src, dst): + """Make a symlink to src from dst + + src and dst are api_paths + """ + src_os_path = self.contents_manager._get_os_path(src) + dst_os_path = self.contents_manager._get_os_path(dst) + print(src_os_path, dst_os_path, os.path.isfile(src_os_path)) + os.symlink(src_os_path, dst_os_path) + def add_code_cell(self, nb): output = nbformat.new_output("display_data", {'application/javascript': "alert('hi');"}) @@ -169,7 +177,7 @@ class TestContentsManager(TestCase): # Test in sub-directory sub_dir = '/foo/' - self.make_dir(cm.root_dir, 'foo') + self.make_dir('foo') model = cm.new_untitled(path=sub_dir, ext='.ipynb') model2 = cm.get(sub_dir + name) assert isinstance(model2, dict) @@ -191,12 +199,12 @@ class TestContentsManager(TestCase): def test_bad_symlink(self): cm = self.contents_manager path = 'test bad symlink' - os_path = self.make_dir(cm.root_dir, path) + self.make_dir(path) file_model = cm.new_untitled(path=path, ext='.txt') # create a broken symlink - os.symlink("target", os.path.join(os_path, "bad symlink")) + self.symlink("target", '%s/%s' % (path, 'bad symlink')) model = cm.get(path) self.assertEqual(model['content'], [file_model]) @@ -206,12 +214,12 @@ class TestContentsManager(TestCase): parent = 'test good symlink' name = 'good symlink' path = '{0}/{1}'.format(parent, name) - os_path = self.make_dir(cm.root_dir, parent) + self.make_dir(parent) file_model = cm.new(path=parent + '/zfoo.txt') # create a good symlink - os.symlink(file_model['name'], os.path.join(os_path, name)) + self.symlink(file_model['path'], path) symlink_model = cm.get(path, content=False) dir_model = cm.get(parent) self.assertEqual( @@ -240,9 +248,8 @@ class TestContentsManager(TestCase): # Test in sub-directory # Create a directory and notebook in that directory sub_dir = '/foo/' - self.make_dir(cm.root_dir, 'foo') + self.make_dir('foo') model = cm.new_untitled(path=sub_dir, type='notebook') - name = model['name'] path = model['path'] # Change the name in the model for rename @@ -279,7 +286,7 @@ class TestContentsManager(TestCase): # Test in sub-directory # Create a directory and notebook in that directory sub_dir = '/foo/' - self.make_dir(cm.root_dir, 'foo') + self.make_dir('foo') model = cm.new_untitled(path=sub_dir, type='notebook') name = model['name'] path = model['path'] @@ -309,7 +316,7 @@ class TestContentsManager(TestCase): parent = u'å b' name = u'nb √.ipynb' path = u'{0}/{1}'.format(parent, name) - os.mkdir(os.path.join(cm.root_dir, parent)) + self.make_dir(parent) orig = cm.new(path=path) # copy with unspecified name diff --git a/IPython/html/tests/launchnotebook.py b/IPython/html/tests/launchnotebook.py index c78bef4e2..18740e48f 100644 --- a/IPython/html/tests/launchnotebook.py +++ b/IPython/html/tests/launchnotebook.py @@ -30,6 +30,7 @@ class NotebookTestBase(TestCase): """ port = 12341 + config = None @classmethod def wait_until_alive(cls): @@ -65,6 +66,7 @@ class NotebookTestBase(TestCase): open_browser=False, ipython_dir=cls.ipython_dir.name, notebook_dir=cls.notebook_dir.name, + config=cls.config, ) # clear log handlers and propagate to root for nose to capture it