Files
gem5/util/gem5-resources-manager/test/mongo_client_test.py
Bobby R. Bruce d11c40dcac misc: Run pre-commit run --all-files
This ensures `isort` is applied to all files in the repo.

Change-Id: Ib7ced1c924ef1639542bf0d1a01c5737f6ba43e9
2023-11-29 22:06:41 -08:00

286 lines
10 KiB
Python

# Copyright (c) 2023 The Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import json
import unittest
from unittest.mock import patch
import mongomock
from api.mongo_client import MongoDBClient
from bson import json_util
from server import (
app,
databases,
)
class TestApi(unittest.TestCase):
"""This is a test class that tests the API."""
API_URL = "http://127.0.0.1:5000"
@patch.object(
MongoDBClient,
"_get_database",
return_value=mongomock.MongoClient().db.collection,
)
def setUp(self, mock_get_database):
"""This method sets up the test environment."""
objects = []
with open("./test/refs/resources.json", "rb") as f:
objects = json.loads(f.read(), object_hook=json_util.object_hook)
self.collection = mock_get_database()
for obj in objects:
self.collection.insert_one(obj)
self.mongo_client = MongoDBClient(
"mongodb://localhost:27017", "test", "test"
)
def tearDown(self):
"""This method tears down the test environment."""
self.collection.drop()
def test_insertResource(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources/"
"tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
ret_value = self.mongo_client.insert_resource(test_resource)
self.assertEqual(ret_value, {"status": "Inserted"})
self.assertEqual(
self.collection.find({"id": "test-resource"})[0], test_resource
)
self.collection.delete_one({"id": "test-resource"})
def test_insertResource_duplicate(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources/"
"tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource)
ret_value = self.mongo_client.insert_resource(test_resource)
self.assertEqual(ret_value, {"status": "Resource already exists"})
def test_findResource_no_version(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource.copy())
ret_value = self.mongo_client.find_resource({"id": "test-resource"})
self.assertEqual(ret_value, test_resource)
self.collection.delete_one({"id": "test-resource"})
def test_findResource_with_version(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource.copy())
test_resource["resource_version"] = "2.0.0"
test_resource["description"] = "test-description2"
self.collection.insert_one(test_resource.copy())
ret_value = self.mongo_client.find_resource(
{"id": "test-resource", "resource_version": "2.0.0"}
)
self.assertEqual(ret_value, test_resource)
def test_findResource_not_found(self):
ret_value = self.mongo_client.find_resource({"id": "test-resource"})
self.assertEqual(ret_value, {"exists": False})
def test_deleteResource(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource.copy())
ret_value = self.mongo_client.delete_resource(
{"id": "test-resource", "resource_version": "1.0.0"}
)
self.assertEqual(ret_value, {"status": "Deleted"})
self.assertEqual(
json.loads(
json_util.dumps(self.collection.find({"id": "test-resource"}))
),
[],
)
def test_updateResource(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
original_resource = test_resource.copy()
self.collection.insert_one(test_resource.copy())
test_resource["author"].append("test-author2")
test_resource["description"] = "test-description2"
ret_value = self.mongo_client.update_resource(
{"original_resource": original_resource, "resource": test_resource}
)
self.assertEqual(ret_value, {"status": "Updated"})
self.assertEqual(
self.collection.find({"id": "test-resource"}, {"_id": 0})[0],
test_resource,
)
def test_checkResourceExists(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource.copy())
ret_value = self.mongo_client.check_resource_exists(
{"id": "test-resource", "resource_version": "1.0.0"}
)
self.assertEqual(ret_value, {"exists": True})
def test_checkResourceExists_not_found(self):
ret_value = self.mongo_client.check_resource_exists(
{"id": "test-resource", "resource_version": "1.0.0"}
)
self.assertEqual(ret_value, {"exists": False})
def test_getVersion(self):
test_resource = {
"category": "diskimage",
"id": "test-resource",
"author": ["test-author"],
"description": "test-description",
"license": "test-license",
"source_url": (
"https://github.com/gem5/gem5-resources"
"/tree/develop/src/x86-ubuntu"
),
"tags": ["test-tag", "test-tag2"],
"example_usage": " test-usage",
"gem5_versions": [
"22.1",
],
"resource_version": "1.0.0",
}
self.collection.insert_one(test_resource.copy())
test_resource["resource_version"] = "2.0.0"
test_resource["description"] = "test-description2"
self.collection.insert_one(test_resource.copy())
ret_value = self.mongo_client.get_versions({"id": "test-resource"})
self.assertEqual(
ret_value,
[{"resource_version": "2.0.0"}, {"resource_version": "1.0.0"}],
)