[SR] Snapshot and restore plugin boilerplate

.i18nrc.json

@@ -42,6 +42,7 @@
     "xpack.searchProfiler": "x-pack/plugins/searchprofiler",
     "xpack.security": "x-pack/plugins/security",
     "xpack.server": "x-pack/server",
+    "xpack.snapshotRestore": "x-pack/plugins/snapshot_restore",
     "xpack.spaces": "x-pack/plugins/spaces",
     "xpack.upgradeAssistant": "x-pack/plugins/upgrade_assistant",
     "xpack.uptime": "x-pack/plugins/uptime",

src/legacy/ui/public/management/index.d.ts

@@ -28,4 +28,8 @@ declare module 'ui/management' {
     allowOverride: boolean
   ): void;
   export const management: any; // TODO - properly provide types
+  export const MANAGEMENT_BREADCRUMB: {
+    text: string;
+    href: string;
+  };
 }

x-pack/index.js

@@ -37,6 +37,7 @@ import { translations } from './plugins/translations';
 import { upgradeAssistant } from './plugins/upgrade_assistant';
 import { uptime } from './plugins/uptime';
 import { ossTelemetry } from './plugins/oss_telemetry';
+import { snapshotRestore } from './plugins/snapshot_restore';
 
 module.exports = function (kibana) {
   return [
@@ -73,5 +74,6 @@ module.exports = function (kibana) {
     upgradeAssistant(kibana),
     uptime(kibana),
     ossTelemetry(kibana),
+    snapshotRestore(kibana),
   ];
 };

x-pack/plugins/snapshot_restore/common/constants.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { LICENSE_TYPE_BASIC, LicenseType } from '../../../common/constants';
+
+const PLUGIN_NAME = 'Snapshot and Restore';
+
+export const PLUGIN = {
+  ID: 'snapshot_restore',
+  MINIMUM_LICENSE_REQUIRED: LICENSE_TYPE_BASIC as LicenseType,
+  getI18nName: (translate: (key: string, config: object) => string): string => {
+    return translate('xpack.snapshotRestore.appName', {
+      defaultMessage: PLUGIN_NAME,
+    });
+  },
+};

x-pack/plugins/snapshot_restore/index.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { Legacy } from 'kibana';
+import { resolve } from 'path';
+import { PLUGIN } from './common/constants';
+import { Plugin as SnapshotRestorePlugin } from './plugin';
+import { createShim } from './shim';
+
+export function snapshotRestore(kibana: any) {
+  return new kibana.Plugin({
+    id: PLUGIN.ID,
+    configPrefix: 'xpack.snapshot_restore',
+    publicDir: resolve(__dirname, 'public'),
+    require: ['kibana', 'elasticsearch', 'xpack_main'],
+    uiExports: {
+      styleSheetPaths: resolve(__dirname, 'public/index.scss'),
+      managementSections: ['plugins/snapshot_restore'],
+    },
+    init(server: Legacy.Server) {
+      const { core, plugins } = createShim(server, PLUGIN.ID);
+      const { i18n } = core;
+      const snapshotRestorePlugin = new SnapshotRestorePlugin();
+
+      // Start plugin
+      snapshotRestorePlugin.start(core, plugins);
+
+      // Register license checker
+      plugins.license.registerLicenseChecker(
+        server,
+        PLUGIN.ID,
+        PLUGIN.getI18nName(i18n.translate),
+        PLUGIN.MINIMUM_LICENSE_REQUIRED
+      );
+    },
+  });
+}

x-pack/plugins/snapshot_restore/plugin.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { registerRoutes } from './server/routes/api/register_routes';
+import { Core, Plugins } from './shim';
+
+export class Plugin {
+  public start(core: Core, plugins: Plugins): void {
+    const router = core.http.createRouter('/api/snapshot_restore/');
+
+    // Register routes
+    registerRoutes(router);
+  }
+}

x-pack/plugins/snapshot_restore/public/_snapshot_restore.scss

@@ -0,0 +1 @@
+/* Snapshot and restore plugin styles */

x-pack/plugins/snapshot_restore/public/app/app.tsx

@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { Component } from 'react';
+import { Redirect, Route, Switch } from 'react-router-dom';
+
+import { BASE_PATH } from './constants';
+import { AppContext } from './services/app_context';
+
+import { SnapshotRestoreHome } from './sections';
+
+export class App extends Component {
+  public static contextType = AppContext;
+
+  public render() {
+    return (
+      <div>
+        <Switch>
+          <Redirect exact from={`${BASE_PATH}`} to={`${BASE_PATH}/repositories`} />
+          <Route exact path={`${BASE_PATH}/:section`} component={SnapshotRestoreHome} />
+        </Switch>
+      </div>
+    );
+  }
+}

x-pack/plugins/snapshot_restore/public/app/constants/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export const BASE_PATH = '/management/elasticsearch/snapshot_restore';

x-pack/plugins/snapshot_restore/public/app/index.tsx

@@ -0,0 +1,40 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import React from 'react';
+import { render } from 'react-dom';
+import { HashRouter } from 'react-router-dom';
+
+import { AppCore, AppPlugins } from '../shim';
+import { App } from './app';
+import { AppContext, AppContextInterface } from './services/app_context';
+
+export { BASE_PATH as CLIENT_BASE_PATH } from './constants';
+
+export const renderReact = async (
+  elem: Element,
+  core: AppCore,
+  plugins: AppPlugins
+): Promise<void> => {
+  const {
+    i18n: { Context: I18nContext },
+  } = core;
+
+  const appContext: AppContextInterface = {
+    core,
+    plugins,
+  };
+
+  render(
+    <I18nContext>
+      <HashRouter>
+        <AppContext.Provider value={appContext}>
+          <App />
+        </AppContext.Provider>
+      </HashRouter>
+    </I18nContext>,
+    elem
+  );
+};

x-pack/plugins/snapshot_restore/public/app/sections/home/home.tsx

@@ -0,0 +1,138 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { PureComponent } from 'react';
+import { Route, RouteComponentProps, Switch } from 'react-router-dom';
+
+import { EuiPageBody, EuiPageContent, EuiSpacer, EuiTab, EuiTabs, EuiTitle } from '@elastic/eui';
+
+import { BASE_PATH } from '../../constants';
+import { AppContext, AppContextInterface } from '../../services/app_context';
+
+import { RepositoryList } from './repository_list';
+import { SnapshotList } from './snapshot_list';
+
+type Section = 'repositories' | 'snapshots';
+
+interface MatchParams {
+  section: Section;
+}
+
+interface Props extends RouteComponentProps<MatchParams> {}
+
+interface State {
+  activeSection: Section;
+}
+
+export class SnapshotRestoreHome extends PureComponent<Props, State> {
+  public static contextType = AppContext;
+
+  public static getDerivedStateFromProps(nextProps: Props) {
+    const {
+      match: {
+        params: { section },
+      },
+    } = nextProps;
+    return {
+      activeSection: section,
+    };
+  }
+  public context!: React.ContextType<typeof AppContext>;
+
+  public readonly state: Readonly<State> = {
+    activeSection: 'repositories' as Section,
+  };
+
+  public componentDidMount() {
+    const {
+      core: { i18n, chrome },
+      plugins: { management },
+    } = this.context as AppContextInterface;
+
+    chrome.breadcrumbs.set([
+      management.constants.BREADCRUMB,
+      {
+        text: i18n.translate('xpack.snapshotRestore.home.BreadcrumbTitle', {
+          defaultMessage: 'Snapshot and Restore',
+        }),
+        href: `#${BASE_PATH}`,
+      },
+    ]);
+  }
+
+  public onSectionChange = (section: Section): void => {
+    const { history } = this.props;
+    history.push(`${BASE_PATH}/${section}`);
+  };
+
+  public render() {
+    const {
+      core: {
+        i18n: { FormattedMessage },
+      },
+    } = this.context as AppContextInterface;
+
+    const tabs = [
+      {
+        id: 'snapshots' as Section,
+        name: (
+          <FormattedMessage
+            id="xpack.snapshotRestore.home.snapshotsTabTitle"
+            defaultMessage="Snapshots"
+          />
+        ),
+        testSubj: 'srSnapshotsTab',
+      },
+      {
+        id: 'repositories' as Section,
+        name: (
+          <FormattedMessage
+            id="xpack.snapshotRestore.home.repositoriesTabTitle"
+            defaultMessage="Repositories"
+          />
+        ),
+        testSubj: 'srRepositoriesTab',
+      },
+    ];
+
+    return (
+      <EuiPageBody>
+        <EuiPageContent>
+          <EuiTitle size="l">
+            <h1>
+              <FormattedMessage
+                id="xpack.snapshotRestore.home.snapshotRestoreTitle"
+                defaultMessage="Snapshot and Restore"
+              />
+            </h1>
+          </EuiTitle>
+
+          <EuiSpacer size="s" />
+
+          <EuiTabs>
+            {tabs.map(tab => (
+              <EuiTab
+                onClick={() => this.onSectionChange(tab.id)}
+                isSelected={tab.id === this.state.activeSection}
+                key={tab.id}
+                data-test-subject={tab.testSubj}
+              >
+                {tab.name}
+              </EuiTab>
+            ))}
+          </EuiTabs>
+
+          <EuiSpacer size="m" />
+
+          <Switch>
+            <Route exact path={`${BASE_PATH}/repositories`} component={RepositoryList} />
+            <Route exact path={`${BASE_PATH}/snapshots`} component={SnapshotList} />
+          </Switch>
+        </EuiPageContent>
+      </EuiPageBody>
+    );
+  }
+}

x-pack/plugins/snapshot_restore/public/app/sections/home/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { SnapshotRestoreHome } from './home';

x-pack/plugins/snapshot_restore/public/app/sections/home/repository_list/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { RepositoryList } from './repository_list';

x-pack/plugins/snapshot_restore/public/app/sections/home/repository_list/repository_list.tsx

@@ -0,0 +1,18 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { PureComponent } from 'react';
+
+import { AppContext } from '../../../services/app_context';
+
+export class RepositoryList extends PureComponent {
+  public static contextType = AppContext;
+  public context!: React.ContextType<typeof AppContext>;
+
+  public render() {
+    return <div>List of repositories</div>;
+  }
+}

x-pack/plugins/snapshot_restore/public/app/sections/home/snapshot_list/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { SnapshotList } from './snapshot_list';

x-pack/plugins/snapshot_restore/public/app/sections/home/snapshot_list/snapshot_list.tsx

@@ -0,0 +1,18 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { PureComponent } from 'react';
+
+import { AppContext } from '../../../services/app_context';
+
+export class SnapshotList extends PureComponent {
+  public static contextType = AppContext;
+  public context!: React.ContextType<typeof AppContext>;
+
+  public render() {
+    return <div>List of snapshots</div>;
+  }
+}