Add V2 scope to /api/clusters endpoint

assets/js/lib/network/index.js

@@ -68,36 +68,36 @@ function handleResponseStatus(response) {
   return response;
 }
 
-export const post = function post(url, data) {
+export const post = function post(url, data, config = null) {
   return networkClient
-    .post(url, data)
+    .post(url, data, config)
     .then(handleResponseStatus)
     .catch((error) => {
       handleError(error);
     });
 };
 
-export const del = function del(url) {
+export const del = function del(url, config = null) {
   return networkClient
-    .delete(url)
+    .delete(url, config)
     .then(handleResponseStatus)
     .catch((error) => {
       handleError(error);
     });
 };
 
-export const put = function put(url, data) {
+export const put = function put(url, data, config = null) {
   return networkClient
-    .put(url, data)
+    .put(url, data, config)
     .then(handleResponseStatus)
     .catch((error) => {
       handleError(error);
     });
 };
 
-export const get = function get(url) {
+export const get = function get(url, config = null) {
   return networkClient
-    .get(url)
+    .get(url, config)
     .then(handleResponseStatus)
     .catch((error) => {
       handleError(error);

assets/js/lib/network/network.test.js

@@ -24,6 +24,22 @@ describe('networkClient', () => {
     clearCredentialsFromStore();
   });
 
+  it('should use default baseURL', async () => {
+    axiosMock.onGet('/api/v1/test').reply(200, { ok: 'ok' });
+
+    const response = await networkClient.get('/test');
+
+    expect(response.data).toEqual({ ok: 'ok' });
+  });
+
+  it('should apply the specific config in each request', async () => {
+    axiosMock.onGet('/base/test').reply(200, { ok: 'ok' });
+
+    const response = await networkClient.get('/test', { baseURL: '/base' });
+
+    expect(response.data).toEqual({ ok: 'ok' });
+  });
+
   it('should attach the access token from the store when a request is made', async () => {
     storeAccessToken('test-access');
 

assets/js/state/sagas/index.js

@@ -119,7 +119,9 @@ function* initialDataFetch() {
   yield put(stopHostsLoading());
 
   yield put(startClustersLoading());
-  const { data: clusters } = yield call(get, '/clusters');
+  const { data: clusters } = yield call(get, '/clusters', {
+    baseURL: '/api/v2',
+  });
   yield put(setClusters(clusters));
   yield put(stopClustersLoading());
 

lib/trento/application/projectors/cluster_projector.ex

@@ -8,7 +8,7 @@ defmodule Trento.ClusterProjector do
     repo: Trento.Repo,
     name: "cluster_projector"
 
-  alias TrentoWeb.V1.ClusterView
+  alias TrentoWeb.V2.ClusterView
 
   alias Trento.Domain.Events.{
     ChecksSelected,

lib/trento_web/controllers/v2/cluster_controller.ex

@@ -0,0 +1,27 @@
+defmodule TrentoWeb.V2.ClusterController do
+  use TrentoWeb, :controller
+  use OpenApiSpex.ControllerSpecs
+
+  alias Trento.Clusters
+
+  alias TrentoWeb.OpenApi.V2.Schema
+
+  plug OpenApiSpex.Plug.CastAndValidate, json_render_error_v2: true
+  action_fallback TrentoWeb.FallbackController
+
+  operation :list,
+    summary: "List Pacemaker Clusters",
+    tags: ["Target Infrastructure"],
+    description: "List all the discovered Pacemaker Clusters on the target infrastructure",
+    responses: [
+      ok:
+        {"A collection of the discovered Pacemaker Clusters", "application/json",
+         Schema.Cluster.PacemakerClustersCollection}
+    ]
+
+  def list(conn, _) do
+    clusters = Clusters.get_all_clusters()
+
+    render(conn, "clusters.json", clusters: clusters)
+  end
+end

lib/trento_web/openapi/v1/schema/cluster.ex

@@ -2,7 +2,6 @@ defmodule TrentoWeb.OpenApi.V1.Schema.Cluster do
   @moduledoc false
 
   require OpenApiSpex
-  require Trento.Domain.Enums.ClusterType, as: ClusterType
 
   alias OpenApiSpex.Schema
 
@@ -37,13 +36,12 @@ defmodule TrentoWeb.OpenApi.V1.Schema.Cluster do
         site: %Schema{type: :string},
         hana_status: %Schema{type: :string},
         attributes: %Schema{
-          title: "ClusterNodeAttributes",
-          type: :array,
-          items: %Schema{type: :string}
+          type: :object,
+          description: "Node attributes",
+          additionalProperties: %Schema{type: :string}
         },
         virtual_ip: %Schema{type: :string},
         resources: %Schema{
-          title: "ClustrNodeResources",
           description: "A list of Cluster resources",
           type: :array,
           items: ClusterResource
@@ -57,7 +55,7 @@ defmodule TrentoWeb.OpenApi.V1.Schema.Cluster do
 
     OpenApiSpex.schema(%{
       title: "SbdDevice",
-      description: "Ad Sbd Device",
+      description: "SBD Device",
       type: :object,
       properties: %{
         device: %Schema{type: :string},
@@ -83,30 +81,28 @@ defmodule TrentoWeb.OpenApi.V1.Schema.Cluster do
         sr_health_state: %Schema{type: :string, description: "SR health state"},
         fencing_type: %Schema{type: :string, description: "Fencing Type"},
         stopped_resources: %Schema{
-          title: "ClusterResource",
           description: "A list of the stopped resources on this HANA Cluster",
           type: :array,
           items: ClusterResource
         },
         nodes: %Schema{
-          title: "HanaClusterNodes",
           type: :array,
           items: HanaClusterNode
         },
         sbd_devices: %Schema{
-          title: "SbdDevice",
           type: :array,
           items: SbdDevice
         }
-      }
+      },
+      required: [:nodes]
     })
   end
 
   defmodule Details do
     @moduledoc false
 
     OpenApiSpex.schema(%{
-      title: "PacemakerClusterDetail",
+      title: "PacemakerClusterDetails",
       description: "Details of the detected PacemakerCluster",
       nullable: true,
       oneOf: [
@@ -135,11 +131,11 @@ defmodule TrentoWeb.OpenApi.V1.Schema.Cluster do
         type: %Schema{
           type: :string,
           description: "Detected type of the cluster",
-          enum: ClusterType.values()
+          enum: [:hana_scale_up, :hana_scale_out, :unknown]
         },
         selected_checks: %Schema{
           title: "SelectedChecks",
-          description: "A list ids of the checks selected for execution on this cluster",
+          description: "A list of check ids selected for an execution on this cluster",
           type: :array,
           items: %Schema{type: :string}
         },

lib/trento_web/openapi/v2/api_spec.ex

@@ -0,0 +1,8 @@
+defmodule TrentoWeb.OpenApi.V2.ApiSpec do
+  @moduledoc """
+  OpenApi specification entry point for V2 version
+  """
+
+  use TrentoWeb.OpenApi.ApiSpec,
+    api_version: "v2"
+end

lib/trento_web/openapi/v2/schema/cluster.ex

@@ -0,0 +1,176 @@
+defmodule TrentoWeb.OpenApi.V2.Schema.Cluster do
+  @moduledoc false
+
+  require OpenApiSpex
+  require Trento.Domain.Enums.ClusterType, as: ClusterType
+
+  alias OpenApiSpex.Schema
+
+  alias TrentoWeb.OpenApi.V1.Schema.{Cluster, Provider, ResourceHealth, Tags}
+
+  defmodule AscsErsClusterNode do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "AscsErsClusterNode",
+      description: "ASCS/ERS Cluster Node",
+      type: :object,
+      properties: %{
+        attributes: %Schema{
+          type: :object,
+          description: "Node attributes",
+          additionalProperties: %Schema{type: :string}
+        },
+        filesystems: %Schema{
+          type: :array,
+          items: %Schema{type: :string},
+          description: "List of filesystems managed in this node"
+        },
+        name: %Schema{
+          type: :string,
+          description: "Node name"
+        },
+        resources: %Schema{
+          type: :array,
+          items: Cluster.ClusterResource,
+          description: "A list of Cluster resources"
+        },
+        roles: %Schema{
+          type: :array,
+          items: %Schema{type: :string, enum: ["ascs", "ers"]},
+          description: "List of roles managed in this node"
+        },
+        virtual_ips: %Schema{
+          type: :array,
+          items: %Schema{type: :string},
+          description: "List of virtual IPs managed in this node"
+        }
+      }
+    })
+  end
+
+  defmodule AscsErsClusterSAPSystem do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "AscsErsClusterSAPSystem",
+      description: "SAP system managed by a ASCS/ERS cluster",
+      type: :object,
+      properties: %{
+        distributed: %Schema{
+          type: :boolean,
+          description: "ASCS and ERS instances are distributed and running in different nodes"
+        },
+        filesystem_resource_based: %Schema{
+          type: :boolean,
+          description:
+            "ASCS and ERS filesystems are handled by the cluster with the Filesystem resource agent"
+        },
+        nodes: %Schema{
+          type: :array,
+          items: AscsErsClusterNode,
+          description: "List of ASCS/ERS nodes for this SAP system"
+        }
+      }
+    })
+  end
+
+  defmodule AscsErsClusterDetails do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "AscsErsClusterDetails",
+      description: "Details of a ASCS/ERS Pacemaker Cluster",
+      type: :object,
+      properties: %{
+        fencing_type: %Schema{
+          type: :string,
+          description: "Fencing type"
+        },
+        sap_systems: %Schema{
+          type: :array,
+          items: AscsErsClusterSAPSystem,
+          description: "List of managed SAP systems in a single or multi SID cluster"
+        },
+        sbd_devices: %Schema{
+          type: :array,
+          items: Cluster.SbdDevice,
+          description: "List of SBD devices used in the cluster"
+        },
+        stopped_resources: %Schema{
+          type: :array,
+          items: Cluster.ClusterResource,
+          description: "List of the stopped resources on this HANA Cluster"
+        }
+      },
+      required: [:sap_systems]
+    })
+  end
+
+  defmodule Details do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "PacemakerClusterDetails",
+      description: "Details of the detected PacemakerCluster",
+      nullable: true,
+      oneOf: [
+        AscsErsClusterDetails,
+        Cluster.HanaClusterDetails
+      ]
+    })
+  end
+
+  defmodule PacemakerCluster do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "PacemakerCluster",
+      description: "A discovered Pacemaker Cluster on the target infrastructure",
+      type: :object,
+      properties: %{
+        id: %Schema{type: :string, description: "Cluster ID", format: :uuid},
+        name: %Schema{type: :string, description: "Cluster name"},
+        sid: %Schema{type: :string, description: "SID"},
+        additional_sids: %Schema{
+          type: :array,
+          items: %Schema{type: :string},
+          description: "Additionally discovered SIDs, such as ASCS/ERS cluster SIDs"
+        },
+        provider: Provider.SupportedProviders,
+        type: %Schema{
+          type: :string,
+          description: "Detected type of the cluster",
+          enum: ClusterType.values()
+        },
+        selected_checks: %Schema{
+          title: "SelectedChecks",
+          description: "A list of check ids selected for an execution on this cluster",
+          type: :array,
+          items: %Schema{type: :string}
+        },
+        health: ResourceHealth,
+        resources_number: %Schema{type: :integer, description: "Resource number", nullable: true},
+        hosts_number: %Schema{type: :integer, description: "Hosts number", nullable: true},
+        cib_last_written: %Schema{
+          type: :string,
+          description: "CIB last written date",
+          nullable: true
+        },
+        details: Details,
+        tags: Tags
+      }
+    })
+  end
+
+  defmodule PacemakerClustersCollection do
+    @moduledoc false
+
+    OpenApiSpex.schema(%{
+      title: "PacemakerClustersCollection",
+      description: "A list of the discovered Pacemaker Clusters",
+      type: :array,
+      items: PacemakerCluster
+    })
+  end
+end