def setUpTestData(cls):
# Create three GitRepository records
repos = (
GitRepository(name="Repo 1",
slug="repo-1",
remote_url="https://example.com/repo1.git"),
GitRepository(name="Repo 2",
slug="repo-2",
remote_url="https://example.com/repo2.git"),
GitRepository(name="Repo 3",
slug="repo-3",
remote_url="https://example.com/repo3.git"),
)
for repo in repos:
repo.save(trigger_resync=False)
cls.form_data = {
"name":
"A new Git repository",
"slug":
"a-new-git-repository",
"remote_url":
"http://example.com/a_new_git_repository.git",
"branch":
"develop",
"_token":
"1234567890abcdef1234567890abcdef",
"provided_contents": [
"extras.configcontext",
"extras.job",
"extras.exporttemplate",
],
}
def setUpTestData(cls):
cls.repos = (
GitRepository(name="Repo 1",
slug="repo-1",
remote_url="https://example.com/repo1.git"),
GitRepository(name="Repo 2",
slug="repo-2",
remote_url="https://example.com/repo2.git"),
GitRepository(name="Repo 3",
slug="repo-3",
remote_url="https://example.com/repo3.git"),
)
for repo in cls.repos:
repo.save(trigger_resync=False)
def test_name_contenttype_uniqueness(self):
"""
The pair of (name, content_type) must be unique for an un-owned ExportTemplate.
See GitHub issue #431.
"""
device_ct = ContentType.objects.get_for_model(Device)
ExportTemplate.objects.create(content_type=device_ct,
name="Export Template 1",
template_code="hello world")
with self.assertRaises(ValidationError):
duplicate_template = ExportTemplate(content_type=device_ct,
name="Export Template 1",
template_code="foo")
duplicate_template.validated_save()
# A differently owned ExportTemplate may have the same name
repo = GitRepository(
name="Test Git Repository",
slug="test-git-repo",
remote_url="http://localhost/git.git",
username="******",
)
repo.save(trigger_resync=False)
nonduplicate_template = ExportTemplate(content_type=device_ct,
name="Export Template 1",
owner=repo,
template_code="bar")
nonduplicate_template.validated_save()
def test_name_uniqueness(self):
"""
Verify that two unowned ConfigContexts cannot share the same name (GitHub issue #431).
"""
ConfigContext.objects.create(name="context 1",
weight=100,
data={
"a": 123,
"b": 456,
"c": 777
})
with self.assertRaises(ValidationError):
duplicate_context = ConfigContext(name="context 1",
weight=200,
data={"c": 666})
duplicate_context.validated_save()
# If a different context is owned by a GitRepository, that's not considered a duplicate
repo = GitRepository(
name="Test Git Repository",
slug="test-git-repo",
remote_url="http://localhost/git.git",
username="******",
)
repo.save(trigger_resync=False)
nonduplicate_context = ConfigContext(name="context 1",
weight=300,
data={"a": "22"},
owner=repo)
nonduplicate_context.validated_save()
def setUp(self):
self.repo = GitRepository(
name="Test Git Repository",
slug="test-git-repo",
remote_url="http://localhost/git.git",
username="******",
)
self.repo.save(trigger_resync=False)
def test_related_object(self):
"""Test that the `related_object` property is computed properly."""
# Case 1: Job, identified by class_path.
with self.settings(JOBS_ROOT=os.path.join(settings.BASE_DIR,
"extras/tests/dummy_jobs")):
job_class = get_job("local/test_pass/TestPass")
job_result = JobResult(
name=job_class.class_path,
obj_type=ContentType.objects.get(app_label="extras",
model="job"),
job_id=uuid.uuid4(),
)
# Can't just do self.assertEqual(job_result.related_object, job_class) here for some reason
self.assertEqual(type(job_result.related_object), type)
self.assertTrue(issubclass(job_result.related_object, Job))
self.assertEqual(job_result.related_object.class_path,
"local/test_pass/TestPass")
job_result.name = "local/no_such_job/NoSuchJob"
self.assertIsNone(job_result.related_object)
job_result.name = "not-a-class-path"
self.assertIsNone(job_result.related_object)
# Case 2: GitRepository, identified by name.
repo = GitRepository(
name="Test Git Repository",
slug="test-git-repo",
remote_url="http://localhost/git.git",
username="******",
)
repo.save(trigger_resync=False)
job_result = JobResult(
name=repo.name,
obj_type=ContentType.objects.get_for_model(repo),
job_id=uuid.uuid4(),
)
self.assertEqual(job_result.related_object, repo)
job_result.name = "No such GitRepository"
self.assertIsNone(job_result.related_object)
# Case 3: Related object with no name, identified by PK/ID
ip_address = IPAddress.objects.create(address="1.1.1.1/32")
job_result = JobResult(
name="irrelevant",
obj_type=ContentType.objects.get_for_model(ip_address),
job_id=ip_address.pk,
)
self.assertEqual(job_result.related_object, ip_address)
job_result.job_id = uuid.uuid4()
self.assertIsNone(job_result.related_object)
def setUpTestData(cls):
# Create Three GitRepository records
repos = (
GitRepository(
name="Repo 1",
slug="repo-1",
branch="main",
provided_contents=[
"extras.configcontext",
],
remote_url="https://example.com/repo1.git",
),
GitRepository(
name="Repo 2",
slug="repo-2",
branch="develop",
provided_contents=[
"extras.configcontext",
"extras.job",
],
remote_url="https://example.com/repo2.git",
),
GitRepository(
name="Repo 3",
slug="repo-3",
branch="next",
provided_contents=[
"extras.configcontext",
"extras.job",
"extras.exporttemplate",
],
remote_url="https://example.com/repo3.git",
),
)
for repo in repos:
repo.save(trigger_resync=False)
def create_helper_repo(name="foobaz", provides=None):
"""
Create a backup and/or intended repo to test helper functions.
"""
content_provides = f"nautobot_golden_config.{provides}"
git_repo = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == content_provides
],
)
git_repo.save(trigger_resync=False)
def setUp(self):
self.user = User.objects.create_user(username="******")
self.factory = RequestFactory()
self.dummy_request = self.factory.get("/no-op/")
self.dummy_request.user = self.user
# Needed for use with the change_logging decorator
self.dummy_request.id = uuid.uuid4()
self.site = Site.objects.create(name="Test Site", slug="test-site")
self.manufacturer = Manufacturer.objects.create(name="Acme",
slug="acme")
self.device_type = DeviceType.objects.create(
manufacturer=self.manufacturer,
model="Frobozz 1000",
slug="frobozz1000")
self.role = DeviceRole.objects.create(name="router", slug="router")
self.device_status = Status.objects.get_for_model(Device).get(
slug="active")
self.device = Device.objects.create(
name="test-device",
device_role=self.role,
device_type=self.device_type,
site=self.site,
status=self.device_status,
)
self.repo = GitRepository(
name="Test Git Repository",
slug="test_git_repo",
remote_url="http://localhost/git.git",
# Provide everything we know we can provide
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
],
)
self.repo.save(trigger_resync=False)
self.job_result = JobResult(
name=self.repo.name,
obj_type=ContentType.objects.get_for_model(GitRepository),
job_id=uuid.uuid4(),
)
def create_git_repos() -> None:
"""Create five instances of Git Repos.
Two GitRepository objects provide Backups.
Two GitRepository objects provide Intended.
One GitRepository objects provide Jinja Templates.
The provided content is matched through a loop, in order to prevent any errors if object ID's change.
"""
name = "test-backup-repo-1"
provides = "nautobot_golden_config.backupconfigs"
git_repo_1 = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == provides
],
)
git_repo_1.save(trigger_resync=False)
name = "test-backup-repo-2"
provides = "nautobot_golden_config.backupconfigs"
git_repo_2 = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == provides
],
)
git_repo_2.save(trigger_resync=False)
name = "test-intended-repo-1"
provides = "nautobot_golden_config.intendedconfigs"
git_repo_3 = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == provides
],
)
git_repo_3.save(trigger_resync=False)
name = "test-intended-repo-2"
provides = "nautobot_golden_config.intendedconfigs"
git_repo_4 = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == provides
],
)
git_repo_4.save(trigger_resync=False)
name = "test-jinja-repo-1"
provides = "nautobot_golden_config.jinjatemplate"
git_repo_5 = GitRepository(
name=name,
slug=slugify(name),
remote_url=f"http://www.remote-repo.com/{name}.git",
branch="main",
username="******",
provided_contents=[
entry.content_identifier
for entry in get_datasource_contents("extras.gitrepository")
if entry.content_identifier == provides
],
)
git_repo_5.save(trigger_resync=False)
def setUp(self):
# Repopulate custom statuses between test cases, as TransactionTestCase deletes them during cleanup
create_custom_statuses(None, verbosity=0)
self.user = User.objects.create_user(username="******")
self.factory = RequestFactory()
self.mock_request = self.factory.get("/no-op/")
self.mock_request.user = self.user
# Needed for use with the change_logging decorator
self.mock_request.id = uuid.uuid4()
self.site = Site.objects.create(name="Test Site", slug="test-site")
self.manufacturer = Manufacturer.objects.create(name="Acme", slug="acme")
self.device_type = DeviceType.objects.create(
manufacturer=self.manufacturer, model="Frobozz 1000", slug="frobozz1000"
)
self.role = DeviceRole.objects.create(name="router", slug="router")
self.device_status = Status.objects.get_for_model(Device).get(slug="active")
self.device = Device.objects.create(
name="test-device",
device_role=self.role,
device_type=self.device_type,
site=self.site,
status=self.device_status,
)
self.repo = GitRepository(
name="Test Git Repository",
slug="test_git_repo",
remote_url="http://localhost/git.git",
# Provide everything we know we can provide
provided_contents=[entry.content_identifier for entry in get_datasource_contents("extras.gitrepository")],
)
self.repo.save(trigger_resync=False)
self.job_result = JobResult.objects.create(
name=self.repo.name,
obj_type=ContentType.objects.get_for_model(GitRepository),
job_id=uuid.uuid4(),
)
self.config_context_schema = {
"_metadata": {
"name": "Config Context Schema 1",
"description": "Schema for defining first names, last names and ages.",
},
"data_schema": {
"title": "Person",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The person's first name.",
},
"lastName": {
"type": "string",
"description": "The person's last name.",
},
"age": {
"description": "Age in years which must be equal to or greater than zero.",
"type": "integer",
"minimum": 0,
},
},
},
}
