resources: Updated tabs to show workloads in a suite.

gem5 · Feb 28, 2024 · 4cb2669 · 4cb2669
1 parent 37f5589
commit 4cb2669
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 47 deletions.
diff --git a/__mocks__/resources-test.json b/__mocks__/resources-test.json
@@ -98,7 +98,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -126,7 +126,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -154,7 +154,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -182,7 +182,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -210,7 +210,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -238,7 +238,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -266,7 +266,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -294,7 +294,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]

diff --git a/__tests__/components/resourceMetadata.test.js b/__tests__/components/resourceMetadata.test.js
@@ -50,7 +50,7 @@ describe('MetaData component', () => {
             "resource_version": "1.0.0",
             "database": "db1",
             "license": "MIT",
-            "workloads": [
+            "workloads_mapping": [
                 "workload1",
                 "workload2"
             ],

diff --git a/__tests__/pages/api/findresources.test.js b/__tests__/pages/api/findresources.test.js
@@ -77,7 +77,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 2,
                     score: 21,
                     ver_latest: '23.0',
@@ -208,7 +208,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 1,
                     score: 90,
                     ver_latest: '23.0',
@@ -268,7 +268,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 2,
                     score: 21,
                     ver_latest: '23.0',
@@ -325,7 +325,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 2,
                     score: 21,
                     ver_latest: '23.0',
@@ -359,7 +359,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 2,
                     score: 21,
                     ver_latest: '23.0',
@@ -418,7 +418,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 1,
                     score: 14,
                     ver_latest: '23.0',
@@ -454,7 +454,7 @@ describe('findResources', () => {
                     gem5_versions: ["23.0"],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
+                    workloads_mapping: ["x86-print-this-15000-with-simpoints", "x86-print-this-15000-with-simpoints-and-checkpoint"],
                     totalMatches: 1,
                     score: 7,
                     ver_latest: '23.0',

diff --git a/__tests__/pages/api/getTabs.test.js b/__tests__/pages/api/getTabs.test.js
@@ -82,7 +82,7 @@ describe("getTabs", () => {
             ],
             "workload_name": "x86-print-this-15000-with-simpoints",
             "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-            "workloads": [
+            "workloads_mapping": [
                 "x86-print-this-15000-with-simpoints",
                 "x86-print-this-15000-with-simpoints-and-checkpoint"
             ]

diff --git a/__tests__/pages/api/getresource.test.js b/__tests__/pages/api/getresource.test.js
@@ -29,7 +29,7 @@ global.fetch = jest.fn((url) => {
                     gem5_versions: ['23.0'],
                     workload_name: 'x86-print-this-15000-with-simpoints',
                     example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                    workloads: [],
+                    workloads_mapping: [],
                     database: 'db1'
                 }],
             }),
@@ -102,7 +102,7 @@ describe('getResource', () => {
             gem5_versions: ['23.0'],
             workload_name: 'x86-print-this-15000-with-simpoints',
             example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-            workloads: [],
+            workloads_mapping: [],
             database: 'db1'
         })
     });
@@ -130,7 +130,7 @@ describe('getResource', () => {
             gem5_versions: ['23.0'],
             workload_name: 'x86-print-this-15000-with-simpoints',
             example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-            workloads: [],
+            workloads_mapping: [],
             database: 'db1'
         })
     });
@@ -173,7 +173,7 @@ describe('getResource', () => {
             gem5_versions: ['23.0'],
             workload_name: 'x86-print-this-15000-with-simpoints',
             example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-            workloads: [],
+            workloads_mapping: [],
             database: 'db1'
         })
     });
@@ -216,7 +216,7 @@ describe('getResource', () => {
             gem5_versions: ['23.0'],
             workload_name: 'x86-print-this-15000-with-simpoints',
             example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-            workloads: [],
+            workloads_mapping: [],
             database: 'db1'
         })
     });

diff --git a/__tests__/pages/api/resources.json b/__tests__/pages/api/resources.json
@@ -45,7 +45,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]
@@ -73,7 +73,7 @@
         ],
         "workload_name": "x86-print-this-15000-with-simpoints",
         "example_usage": "get_resource(resource_name=\"x86-print-this-1500-simpoints\")",
-        "workloads": [
+        "workloads_mapping": [
             "x86-print-this-15000-with-simpoints",
             "x86-print-this-15000-with-simpoints-and-checkpoint"
         ]

diff --git a/__tests__/pages/resources/[id]/[[...page]].test.js b/__tests__/pages/resources/[id]/[[...page]].test.js
@@ -155,7 +155,7 @@ describe("Resource-specific component", () => {
                 gem5_versions: ['23.0'],
                 workload_name: 'x86-print-this-15000-with-simpoints',
                 example_usage: 'get_resource(resource_name="x86-print-this-1500-simpoints")',
-                workloads: [],
+                workloads_mapping: [],
                 database: 'db1'
             }))
         }))

diff --git a/components/resourceMetadata.js b/components/resourceMetadata.js
@@ -137,20 +137,20 @@ export default function MetaData({ resource, className, metaFields, showMetadata
                             : null
                     }
                     {
-                        (resource.workloads && resource.workloads.length > 0) ?
+                        (resource.workloads_mapping && resource.workloads_mapping.length > 0) ?
                             <Row className="border-bottom">
                                 <p className="text-muted main-text-regular">Depend on this resource</p>
                                 <div className="main-text-regular">
                                     {
-                                        resource.workloads.map((workload, index) => {
+                                        resource.workloads_mapping.map((workload, index) => {
                                             return (
                                                 <span key={workload}>
                                                     <a
                                                         href={process.env.BASE_PATH + '/resources/' + workload + `?database=${resource.database}`}
                                                     >
                                                         {workload}
                                                     </a>
-                                                    {index != resource.workloads.length - 1 ? ', ' : ''}
+                                                    {index != resource.workloads_mapping.length - 1 ? ', ' : ''}
                                                 </span>
                                             )
                                         })

diff --git a/components/resourceTab.js b/components/resourceTab.js
@@ -16,6 +16,7 @@ import rehypeHighlight from "rehype-highlight";
 import rehypeSlug from "rehype-slug";
 import rehypeRaw from "rehype-raw";
 import remarkFrontmatter from "remark-frontmatter";
+import CopyIcon from "./copyIcon";
 
 export function createTab(tab) {
   if (!"content" in tab) return null;
@@ -30,13 +31,15 @@ export function createTab(tab) {
       content = String(tab.content);
       break;
     case "array":
-      content = tab.content.map((item, index) => {
-        return (
-          <div key={index}>
-            {item}
-          </div>
-        );
-      });
+      content = (
+        <CopyIcon>
+          <pre>
+            <code class="hljs language-python">
+              {JSON.stringify(tab.content, null, 4)}
+            </code>
+          </pre>
+        </CopyIcon>
+      );
       break;
     case "object":
       content = Object.keys(tab.content).map((key, index) => {
@@ -131,15 +134,15 @@ export default function ResourceTab({ resource, requiredTabs, additionalInfoTabs
       >
         <Tab eventKey="readme" title="Readme">
           <ReactMarkdown
-                    className="markdown-body mt-3"
-                    rehypePlugins={[
-                        [rehypeHighlight, { ignoreMissing: true }],
-                        rehypeRaw,
-                        rehypeSlug,
-                    ]}
-                    remarkPlugins={[remarkGfm, remarkToc, remarkFrontmatter]}
-              >
-                {resource.description ?? 'This is a description of the resource.'}
+            className="markdown-body mt-3"
+            rehypePlugins={[
+              [rehypeHighlight, { ignoreMissing: true }],
+              rehypeRaw,
+              rehypeSlug,
+            ]}
+            remarkPlugins={[remarkGfm, remarkToc, remarkFrontmatter]}
+          >
+            {resource.description ?? 'This is a description of the resource.'}
           </ReactMarkdown>
         </Tab>
         <Tab eventKey="changelog" title="Changelog">

diff --git a/components/tabs/rawTab.js b/components/tabs/rawTab.js
@@ -26,7 +26,7 @@ export default function RawTab({ resource }) {
         resource = JSON.parse(JSON.stringify(resource));
         delete resource.database
         delete resource._id
-        delete resource.workloads
+        delete resource.workloads_mapping
         textToHtml(JSON.stringify(resource, null, 4));
     }, [resource]);
     return (

diff --git a/gem5.config.json b/gem5.config.json
@@ -110,6 +110,15 @@
                     }
                 },
                 "metadata": {}
+            },
+            "suite": {
+                "tab": {
+                    "workloads": {
+                        "displayName": "Workloads"
+                    }
+                },
+                "additionalInfo": {},
+                "metadata": {}
             }
         }
     }

diff --git a/pages/api/json/getResourceByID.js b/pages/api/json/getResourceByID.js
@@ -49,7 +49,7 @@ export default async function getResourceByIDJSON(id, database, version) {
     if (!resource) {
         return { error: 'Resource not found' }
     }
-    resource.workloads = workloads;
+    resource.workloads_mapping = workloads;
     resource.database = database;
     return resource;
 }
diff --git a/pages/api/mongodb/getResourceByID.js b/pages/api/mongodb/getResourceByID.js
@@ -86,7 +86,7 @@ async function getResourceByID(token, url, dataSource, database, collection, id,
         })
     }).catch(err => console.log(err));
     let workloads = await dependendWorkloads.json();
-    resource.workloads = Object.values(workloads['documents']).map(workload => workload['_id']);
+    resource.workloads_mapping = Object.values(workloads['documents']).map(workload => workload['_id']);
 
     return resource;
 }