def test_update_project_logo(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
project = ltd_client.update_project('test_project1', logo='logo.jpg')
assert project.code == 'test_project1'
assert project.title == 'test_project1'
assert project.description == 'description1'
assert project.logo == 'logo.jpg'
def test_get_project_returns_the_project(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project', description='A very long string'))
project = ltd_client.get_project('test_project')
assert project.code == 'test_project'
assert project.title == 'test_project'
assert project.description == 'A very long string'
assert project.logo is None
def test_update_project_description(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
project = ltd_client.update_project('test_project1',
description='new description')
assert project.code == 'test_project1'
assert project.title == 'test_project1'
assert project.description == 'new description'
def test_get_users_returns_the_users(ltd_client: ListTheDocs):
ltd_client.add_user('foo')
ltd_client.add_user('bar')
users = ltd_client.get_users()
assert isinstance(users, list)
assert len(users) == 3
users = sorted(users, key=lambda u: u.name)
assert users[0].name == 'bar'
assert users[1].name == 'foo'
assert users[2].name == 'root'
def test_add_role_to_user(ltd_client: ListTheDocs):
ltd_client.add_project(Project('test_project', 'empty description'))
ltd_client.add_role(
'root', Role(role_name='PROJECT_MANAGER', project_code='test_project'))
roles = ltd_client.get_roles('root')
assert isinstance(roles, list)
assert isinstance(roles[0], Role)
assert roles[0].role_name == 'PROJECT_MANAGER'
assert roles[0].project_code == 'test_project'
def test_get_user_returns_the_user(ltd_client: ListTheDocs):
ltd_client.add_user('foo')
user = ltd_client.get_user('foo')
assert isinstance(user, User)
assert user.name == 'foo'
assert user.is_admin is False
assert isinstance(user.api_keys, list)
assert len(user.api_keys) == 1
assert isinstance(user.api_keys[0].key, str)
assert isinstance(user.api_keys[0].created_at, datetime.datetime)
assert user.api_keys[0].is_valid is True
def test_add_version(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
project = ltd_client.add_version(
'test_project1', Version('1.0.0', 'www.example.com/index.html'))
assert project.code == 'test_project1'
assert project.title == 'test_project1'
assert project.description == 'description1'
assert project.logo is None
assert isinstance(project.versions, (tuple, list))
assert len(project.versions) == 1
assert project.versions[0].name == '1.0.0'
assert project.versions[0].url == 'www.example.com/index.html'
def test_get_projects_returns_all_the_projects(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
ltd_client.add_project(
Project(title='test_project2',
description='description2',
logo='img.png'))
projects = ltd_client.get_projects()
assert isinstance(projects, tuple)
assert len(projects) == 2
assert projects[0].code == 'test_project1'
assert projects[0].title == 'test_project1'
assert projects[0].description == 'description1'
assert projects[0].logo is None
assert projects[1].code == 'test_project2'
assert projects[1].title == 'test_project2'
assert projects[1].description == 'description2'
assert projects[1].logo == 'img.png'
def test_add_user_creates_a_new_user(ltd_client: ListTheDocs):
user = ltd_client.add_user('foo', is_admin=True)
assert isinstance(user, User)
assert user.name == 'foo'
assert user.is_admin is True
assert isinstance(user.api_keys, list)
assert len(user.api_keys) == 1
assert isinstance(user.api_keys[0].key, str)
assert isinstance(user.api_keys[0].created_at, datetime.datetime)
assert user.api_keys[0].is_valid is True
def test_delete_project(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
ltd_client.add_version('test_project1',
Version('1.0.0', 'www.example.com/index.html'))
ltd_client.delete_project('test_project1')
project = ltd_client.get_project('test_project1')
assert project is None
def test_remove_role_from_user(ltd_client: ListTheDocs):
ltd_client.add_project(Project('test_project', 'empty description'))
ltd_client.add_role(
'root', Role(role_name='PROJECT_MANAGER', project_code='test_project'))
ltd_client.remove_role(
'root', Role(role_name='PROJECT_MANAGER', project_code='test_project'))
roles = ltd_client.get_roles('root')
assert isinstance(roles, list)
assert len(roles) == 0
def test_remove_version(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
# Add multiple versions
ltd_client.add_version(
'test_project1', Version('1.0.0', 'www.example.com/1.0.0/index.html'))
ltd_client.add_version(
'test_project1', Version('2.0.0', 'www.example.com/2.0.0/index.html'))
# Remove a version
ltd_client.delete_version('test_project1', '1.0.0')
project = ltd_client.get_project('test_project1')
assert project.code == 'test_project1'
assert project.title == 'test_project1'
assert project.description == 'description1'
assert len(project.versions) == 1
assert project.versions[0].name == '2.0.0'
assert project.versions[0].url == 'www.example.com/2.0.0/index.html'
def test_update_version_link(ltd_client: ListTheDocs):
ltd_client.add_project(
Project(title='test_project1', description='description1'))
# Add multiple versions
ltd_client.add_version(
'test_project1', Version('1.0.0', 'www.example.com/1.0.0/index.html'))
ltd_client.add_version(
'test_project1', Version('2.0.0', 'www.example.com/2.0.0/index.html'))
ltd_client.update_version('test_project1',
'2.0.0',
url='www.newexample.com/2.0.0/index.html')
project = ltd_client.get_project('test_project1')
assert project.code == 'test_project1'
assert project.title == 'test_project1'
assert project.description == 'description1'
assert len(project.versions) == 2
assert project.versions[0].name == '1.0.0'
assert project.versions[0].url == 'www.example.com/1.0.0/index.html'
assert project.versions[1].name == '2.0.0'
assert project.versions[1].url == 'www.newexample.com/2.0.0/index.html'
def test_get_projects_where_none_exists(ltd_client: ListTheDocs):
projects = ltd_client.get_projects()
assert len(projects) == 0
def test_get_missing_project(ltd_client: ListTheDocs):
project = ltd_client.get_project('test_project')
assert project is None
def ltd_client(client):
ltd = ListTheDocs()
ltd._session = MockClientSession(client)
return ltd
def test_get_user_returns_none_when_user_does_not_exists(
ltd_client: ListTheDocs):
assert ltd_client.get_user('foo') is None
