merge: Integrate v2.1 progress into public repository

This pull request integrates the changes planned for the v2.1 release of
OpenDC into the public Github repository in order to sync the progress
of both repositories.

10 files changed, 139 insertions, 55 deletions

diff --git a/opendc-web/opendc-web-ui/src/util/authorizations.js b/opendc-web/opendc-web-ui/src/util/authorizations.js
index 4086b35d..ce5d34b6 100644
--- a/opendc-web/opendc-web-ui/src/util/authorizations.js
+++ b/opendc-web/opendc-web-ui/src/util/authorizations.js
@@ -1,7 +1,11 @@
+import HomeIcon from '@patternfly/react-icons/dist/js/icons/home-icon'
+import EditIcon from '@patternfly/react-icons/dist/js/icons/edit-icon'
+import EyeIcon from '@patternfly/react-icons/dist/js/icons/eye-icon'
+
 export const AUTH_ICON_MAP = {
-    OWN: 'home',
-    EDIT: 'pencil',
-    VIEW: 'eye',
+    OWN: HomeIcon,
+    EDIT: EditIcon,
+    VIEW: EyeIcon,
 }
 
 export const AUTH_DESCRIPTION_MAP = {
diff --git a/opendc-web/opendc-web-ui/src/util/available-metrics.js b/opendc-web/opendc-web-ui/src/util/available-metrics.js
index 807bc0c1..b21ab150 100644
--- a/opendc-web/opendc-web-ui/src/util/available-metrics.js
+++ b/opendc-web/opendc-web-ui/src/util/available-metrics.js
@@ -1,12 +1,28 @@
+export const METRIC_GROUPS = {
+    'Host Metrics': [
+        'total_overcommitted_burst',
+        'total_power_draw',
+        'total_failure_vm_slices',
+        'total_granted_burst',
+        'total_interfered_burst',
+        'total_requested_burst',
+        'mean_cpu_usage',
+        'mean_cpu_demand',
+        'mean_num_deployed_images',
+        'max_num_deployed_images',
+    ],
+    'Compute Service Metrics': ['total_vms_submitted', 'total_vms_queued', 'total_vms_finished', 'total_vms_failed'],
+}
+
 export const AVAILABLE_METRICS = [
+    'mean_cpu_usage',
+    'mean_cpu_demand',
+    'total_requested_burst',
+    'total_granted_burst',
     'total_overcommitted_burst',
+    'total_interfered_burst',
     'total_power_draw',
     'total_failure_vm_slices',
-    'total_granted_burst',
-    'total_interfered_burst',
-    'total_requested_burst',
-    'mean_cpu_usage',
-    'mean_cpu_demand',
     'mean_num_deployed_images',
     'max_num_deployed_images',
     'total_vms_submitted',
@@ -65,3 +81,22 @@ export const METRIC_UNITS = {
     total_vms_finished: 'VMs',
     total_vms_failed: 'VMs',
 }
+
+export const METRIC_DESCRIPTIONS = {
+    total_overcommitted_burst:
+        'The total CPU clock cycles lost due to overcommitting of resources. This metric is an indicator for resource overload.',
+    total_requested_burst: 'The total CPU clock cycles that were requested by all virtual machines.',
+    total_granted_burst: 'The total CPU clock cycles executed by the hosts.',
+    total_interfered_burst: 'The total CPU clock cycles lost due to resource interference between virtual machines.',
+    total_power_draw: 'The average power usage in watts.',
+    mean_cpu_usage: 'The average amount of CPU clock cycles consumed by all virtual machines on a host.',
+    mean_cpu_demand: 'The average amount of CPU clock cycles requested by all powered on virtual machines on a host.',
+    mean_num_deployed_images: 'The average number of virtual machines deployed on a host.',
+    max_num_deployed_images: 'The maximum number of virtual machines deployed at any time.',
+    total_failure_vm_slices: 'The total amount of CPU clock cycles lost due to failure.',
+    total_vms_submitted: 'The total number of virtual machines scheduled by the compute service.',
+    total_vms_queued:
+        'The maximum number of virtual machines waiting to be scheduled by the compute service at any point.',
+    total_vms_finished: 'The total number of virtual machines that completed successfully.',
+    total_vms_failed: 'The total number of virtual machines that failed during execution.',
+}
diff --git a/opendc-web/opendc-web-ui/src/util/date-time.js b/opendc-web/opendc-web-ui/src/util/date-time.js
index 66efdf5b..7e2f6623 100644
--- a/opendc-web/opendc-web-ui/src/util/date-time.js
+++ b/opendc-web/opendc-web-ui/src/util/date-time.js
@@ -7,19 +7,7 @@
  * @returns {string} A human-friendly string version of that date and time.
  */
 export function parseAndFormatDateTime(dateTimeString) {
-    return formatDateTime(parseDateTime(dateTimeString))
-}
-
-/**
- * Parses date-time string representations and returns a parsed object.
- *
- * The format assumed is "YYYY-MM-DDTHH:MM:SS".
- *
- * @param dateTimeString A string expressing a date and a time, in the above mentioned format.
- * @returns {object} A Date object with the parsed date and time information as content.
- */
-export function parseDateTime(dateTimeString) {
-    return new Date(dateTimeString + '.000Z')
+    return formatDateTime(new Date(dateTimeString))
 }
 
 /**
diff --git a/opendc-web/opendc-web-ui/src/util/date-time.test.js b/opendc-web/opendc-web-ui/src/util/date-time.test.js
index 3d95eba6..431e39f7 100644
--- a/opendc-web/opendc-web-ui/src/util/date-time.test.js
+++ b/opendc-web/opendc-web-ui/src/util/date-time.test.js
@@ -1,18 +1,4 @@
-import { convertSecondsToFormattedTime, parseDateTime } from './date-time'
-
-describe('date-time parsing', () => {
-    it('reads components properly', () => {
-        const dateString = '2017-09-27T20:55:01'
-        const parsedDate = parseDateTime(dateString)
-
-        expect(parsedDate.getUTCFullYear()).toEqual(2017)
-        expect(parsedDate.getUTCMonth()).toEqual(8)
-        expect(parsedDate.getUTCDate()).toEqual(27)
-        expect(parsedDate.getUTCHours()).toEqual(20)
-        expect(parsedDate.getUTCMinutes()).toEqual(55)
-        expect(parsedDate.getUTCSeconds()).toEqual(1)
-    })
-})
+import { convertSecondsToFormattedTime } from './date-time'
 
 describe('tick formatting', () => {
     it("returns '0s' for numbers <= 0", () => {
diff --git a/opendc-web/opendc-web-ui/src/util/effect-ref.js b/opendc-web/opendc-web-ui/src/util/effect-ref.js
new file mode 100644
index 00000000..cda0324b
--- /dev/null
+++ b/opendc-web/opendc-web-ui/src/util/effect-ref.js
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { useCallback, useRef } from 'react'
+
+const noop = () => {}
+
+/**
+ * A hook that will invoke the specified callback when the reference returned by this function is initialized.
+ * The callback can return an optional clean up function.
+ */
+export function useEffectRef(callback) {
+    const disposeRef = useRef(noop)
+    return useCallback((element) => {
+        disposeRef.current()
+        disposeRef.current = noop
+
+        if (element) {
+            disposeRef.current = callback(element) || noop
+        }
+    }, []) // eslint-disable-line react-hooks/exhaustive-deps
+}
diff --git a/opendc-web/opendc-web-ui/src/util/sidebar-space.js b/opendc-web/opendc-web-ui/src/util/sidebar-space.js
deleted file mode 100644
index ef09d40a..00000000
--- a/opendc-web/opendc-web-ui/src/util/sidebar-space.js
+++ /dev/null
@@ -1,2 +0,0 @@
-export const isCollapsible = (location) =>
-    location.pathname.indexOf('portfolios') === -1 && location.pathname.indexOf('scenarios') === -1
diff --git a/opendc-web/opendc-web-ui/src/util/state-utils.js b/opendc-web/opendc-web-ui/src/util/state-utils.js
deleted file mode 100644
index e5b695c3..00000000
--- a/opendc-web/opendc-web-ui/src/util/state-utils.js
+++ /dev/null
@@ -1,6 +0,0 @@
-export const getState = (dispatch) =>
-    new Promise((resolve) => {
-        dispatch((dispatch, getState) => {
-            resolve(getState())
-        })
-    })
diff --git a/opendc-web/opendc-web-ui/src/util/tile-calculations.js b/opendc-web/opendc-web-ui/src/util/tile-calculations.js
index 764ae6ac..374ca48c 100644
--- a/opendc-web/opendc-web-ui/src/util/tile-calculations.js
+++ b/opendc-web/opendc-web-ui/src/util/tile-calculations.js
@@ -18,8 +18,8 @@ function getWallSegments(tiles) {
                 }
 
                 let doInsert = true
-                for (let tileIndex in tiles) {
-                    if (tiles[tileIndex].positionX === x + dX && tiles[tileIndex].positionY === y + dY) {
+                for (const tile of tiles) {
+                    if (tile.positionX === x + dX && tile.positionY === y + dY) {
                         doInsert = false
                         break
                     }
diff --git a/opendc-web/opendc-web-ui/src/util/timeline.js b/opendc-web/opendc-web-ui/src/util/timeline.js
deleted file mode 100644
index 7c8a3ef0..00000000
--- a/opendc-web/opendc-web-ui/src/util/timeline.js
+++ /dev/null
@@ -1,9 +0,0 @@
-export function convertTickToPercentage(tick, maxTick) {
-    if (maxTick === 0) {
-        return '0%'
-    } else if (tick > maxTick) {
-        return (maxTick / (maxTick + 1)) * 100 + '%'
-    }
-
-    return (tick / (maxTick + 1)) * 100 + '%'
-}
diff --git a/opendc-web/opendc-web-ui/src/util/topology-schema.js b/opendc-web/opendc-web-ui/src/util/topology-schema.js
new file mode 100644
index 00000000..7779ccfe
--- /dev/null
+++ b/opendc-web/opendc-web-ui/src/util/topology-schema.js
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { schema } from 'normalizr'
+
+const Cpu = new schema.Entity('cpus', {}, { idAttribute: '_id' })
+const Gpu = new schema.Entity('gpus', {}, { idAttribute: '_id' })
+const Memory = new schema.Entity('memories', {}, { idAttribute: '_id' })
+const Storage = new schema.Entity('storages', {}, { idAttribute: '_id' })
+
+export const Machine = new schema.Entity(
+    'machines',
+    {
+        cpus: [Cpu],
+        gpus: [Gpu],
+        memories: [Memory],
+        storages: [Storage],
+    },
+    { idAttribute: '_id' }
+)
+
+export const Rack = new schema.Entity('racks', { machines: [Machine] }, { idAttribute: '_id' })
+
+export const Tile = new schema.Entity('tiles', { rack: Rack }, { idAttribute: '_id' })
+
+export const Room = new schema.Entity('rooms', { tiles: [Tile] }, { idAttribute: '_id' })
+
+export const Topology = new schema.Entity('topologies', { rooms: [Room] }, { idAttribute: '_id' })