def test_interact_with_workspace_without_encryption(settings):
# Set up a toy workspace.
workspace = Workspace(
id=settings.workspace_id,
name="e2e-tests - without encryption",
description="A test workspace for the structurizr-python client.",
)
system = workspace.model.add_software_system(
name="Software System", description="Description"
)
person = workspace.model.add_person(name="Person", description="Description")
person.uses(system, "")
context_view = workspace.views.create_system_context_view(
software_system=system, key="SystemContext", description="Description"
)
context_view.add_all_elements()
# Upload the workspace and immediately retrieve it again.
with StructurizrClient(settings=settings) as client:
client.put_workspace(workspace)
remote_ws = client.get_workspace()
# Verify the remote workspace.
assert remote_ws.model.get_software_system_with_name("Software System") is not None
assert remote_ws.model.get_person_with_name("Person") is not None
assert len(remote_ws.model.relationships) == 1
assert len(remote_ws.views.get_system_context_views()) == 1
# Verify the generated archive.
archives = list(settings.workspace_archive_location.glob("*.json.gz"))
assert len(archives) == 1
archived_ws: Workspace = Workspace.load(archives[0])
assert archived_ws.id == 20081
assert archived_ws.name == "structurizr-python e2e-tests - without encryption"
assert len(archived_ws.model.software_systems) == 1
def test_empty_workspace_without_encryption(settings):
workspace = Workspace(
id=settings.workspace_id,
name="e2e-tests - without encryption",
description="A test workspace for the structurizr-python client.",
)
with StructurizrClient(settings=settings) as client:
client.put_workspace(workspace)
remote_ws = client.get_workspace()
assert remote_ws.name == workspace.name
assert remote_ws.description == workspace.description
# Copyright (c) 2020, Moritz E. Beber.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Provide a command line tool for uploading workspace examples."""
import logging
import sys
from importlib import import_module
from structurizr import StructurizrClient, StructurizrClientSettings
if __name__ == "__main__":
logging.basicConfig(level="INFO")
example = import_module(sys.argv[1])
workspace = example.main()
settings = StructurizrClientSettings()
workspace.id = settings.workspace_id
client = StructurizrClient(settings=settings)
with client:
client.put_workspace(workspace)
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Provide a command line tool for uploading workspace examples."""
import logging
import sys
from importlib import import_module
from structurizr import StructurizrClient, StructurizrClientSettings
if __name__ == "__main__":
logging.basicConfig(level="INFO")
example = import_module(sys.argv[1])
workspace = example.main()
settings = StructurizrClientSettings()
workspace.id = settings.workspace_id
client = StructurizrClient(settings=settings)
with client.lock():
client.put_workspace(workspace)
def test_unlock_workspace(settings):
client = StructurizrClient(settings=settings)
client.lock_workspace()
assert client.unlock_workspace()
client.close()
def test_lock_workspace(settings):
"""Check locking a workspace."""
client = StructurizrClient(settings=settings)
client.unlock_workspace()
assert client.lock_workspace()
client.close()