|
|
"""Test the notebooks webservice API."""
|
|
|
|
|
|
|
|
|
import os
|
|
|
import sys
|
|
|
import json
|
|
|
from zmq.utils import jsonapi
|
|
|
|
|
|
import requests
|
|
|
|
|
|
from IPython.html.tests.launchnotebook import NotebookTestBase
|
|
|
|
|
|
class APITest(NotebookTestBase):
|
|
|
"""Test the kernels web service API"""
|
|
|
|
|
|
def notebook_url(self):
|
|
|
return super(APITest,self).base_url() + 'api/notebooks'
|
|
|
|
|
|
def mknb(self, name='', path='/'):
|
|
|
url = self.notebook_url() + path
|
|
|
return url, requests.post(url)
|
|
|
|
|
|
def delnb(self, name, path='/'):
|
|
|
url = self.notebook_url() + path + name
|
|
|
r = requests.delete(url)
|
|
|
return r.status_code
|
|
|
|
|
|
def test_notebook_handler(self):
|
|
|
# POST a notebook and test the dict thats returned.
|
|
|
#url, nb = self.mknb()
|
|
|
url = self.notebook_url()
|
|
|
nb = requests.post(url)
|
|
|
data = nb.json()
|
|
|
assert isinstance(data, dict)
|
|
|
self.assertIn('name', data)
|
|
|
self.assertIn('path', data)
|
|
|
self.assertEqual(data['name'], u'Untitled0.ipynb')
|
|
|
self.assertEqual(data['path'], u'/')
|
|
|
|
|
|
# GET list of notebooks in directory.
|
|
|
r = requests.get(url)
|
|
|
assert isinstance(r.json(), list)
|
|
|
assert isinstance(r.json()[0], dict)
|
|
|
|
|
|
self.delnb('Untitled0.ipynb')
|
|
|
|
|
|
# GET with a notebook name.
|
|
|
url, nb = self.mknb()
|
|
|
data = nb.json()
|
|
|
url = self.notebook_url() + '/Untitled0.ipynb'
|
|
|
r = requests.get(url)
|
|
|
assert isinstance(data, dict)
|
|
|
self.assertEqual(r.json(), data)
|
|
|
|
|
|
# PATCH (rename) request.
|
|
|
new_name = {'name':'test.ipynb'}
|
|
|
r = requests.patch(url, data=jsonapi.dumps(new_name))
|
|
|
data = r.json()
|
|
|
assert isinstance(data, dict)
|
|
|
|
|
|
# make sure the patch worked.
|
|
|
new_url = self.notebook_url() + '/test.ipynb'
|
|
|
r = requests.get(new_url)
|
|
|
assert isinstance(r.json(), dict)
|
|
|
self.assertEqual(r.json(), data)
|
|
|
|
|
|
# GET bad (old) notebook name.
|
|
|
r = requests.get(url)
|
|
|
self.assertEqual(r.status_code, 404)
|
|
|
|
|
|
# POST notebooks to folders one and two levels down.
|
|
|
os.makedirs(os.path.join(self.notebook_dir.name, 'foo'))
|
|
|
os.makedirs(os.path.join(self.notebook_dir.name, 'foo','bar'))
|
|
|
assert os.path.isdir(os.path.join(self.notebook_dir.name, 'foo'))
|
|
|
url, nb = self.mknb(path='/foo/')
|
|
|
url2, nb2 = self.mknb(path='/foo/bar/')
|
|
|
data = nb.json()
|
|
|
data2 = nb2.json()
|
|
|
assert isinstance(data, dict)
|
|
|
assert isinstance(data2, dict)
|
|
|
self.assertIn('name', data)
|
|
|
self.assertIn('path', data)
|
|
|
self.assertEqual(data['name'], u'Untitled0.ipynb')
|
|
|
self.assertEqual(data['path'], u'/foo/')
|
|
|
self.assertIn('name', data2)
|
|
|
self.assertIn('path', data2)
|
|
|
self.assertEqual(data2['name'], u'Untitled0.ipynb')
|
|
|
self.assertEqual(data2['path'], u'/foo/bar/')
|
|
|
|
|
|
# GET request on notebooks one and two levels down.
|
|
|
r = requests.get(url+'/Untitled0.ipynb')
|
|
|
r2 = requests.get(url2+'/Untitled0.ipynb')
|
|
|
assert isinstance(r.json(), dict)
|
|
|
self.assertEqual(r.json(), data)
|
|
|
assert isinstance(r2.json(), dict)
|
|
|
self.assertEqual(r2.json(), data2)
|
|
|
|
|
|
# PATCH notebooks that are one and two levels down.
|
|
|
new_name = {'name': 'testfoo.ipynb'}
|
|
|
r = requests.patch(url+'/Untitled0.ipynb', data=jsonapi.dumps(new_name))
|
|
|
r = requests.get(url+'/testfoo.ipynb')
|
|
|
data = r.json()
|
|
|
assert isinstance(data, dict)
|
|
|
self.assertIn('name', data)
|
|
|
self.assertEqual(data['name'], 'testfoo.ipynb')
|
|
|
r = requests.get(url+'/Untitled0.ipynb')
|
|
|
self.assertEqual(r.status_code, 404)
|
|
|
|
|
|
# DELETE notebooks
|
|
|
r0 = self.delnb('test.ipynb')
|
|
|
r1 = self.delnb('testfoo.ipynb', '/foo/')
|
|
|
r2 = self.delnb('Untitled0.ipynb', '/foo/bar/')
|
|
|
self.assertEqual(r0, 204)
|
|
|
self.assertEqual(r1, 204)
|
|
|
self.assertEqual(r2, 204)
|
|
|
|
