Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw

* 'master' of github.com:spotify/backstage: (110 commits)
  chore(catalog-backend): removing redudant classes and some functions
  chore(deps-dev): bump @types/webpack from 4.41.21 to 4.41.22 (#2765)
  move codecov.yml to .github
  feat(catalog-backend): add batch concurrency
  create-app: remove build step
  cli: simplify jest transform ignore regex
  feat(catalog-backend): introduce batching, speed up reading and writing of large datasets
  Techdocs: add Azure DevOps prepare support (#2748)
  feat(techdocs-header): Show breadcrumbs on docs page (#2786)
  changesets: add entry for create-app template location fix
  create-app: revert to github location type for example templates
  fix: make catalog filter work again
  Use new url scheme for techdocs
  feat: remove LocationProcessor.processEntity
  Add Dockerfile for helm chart
  feat: use the new UrlReader in the CodeOwnersProcessor
  feat: use new UrlReader in PlaceholderProcessor
  feat: remove the backstage.io/definition-at-location annotation
  Update loud-lamps-visit.md
  feat(proxy-backend): limit the forwarded http headers to a safe set
  ...

plugins/kubernetes/README.md

@@ -11,3 +11,24 @@ Your plugin has been added to the example app in this repository, meaning you'll
 You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
 This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
 It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
+
+## Surfacing your Kubernetes components as part of an entity
+
+### Adding the entity annotation
+
+In order for Backstage to detect that an entity has Kubernetes components,
+the following annotation should be added to the entity.
+
+```yaml
+annotations:
+  'backstage.io/kubernetes-id': dice-roller
+```
+
+### Labeling Kubernetes components
+
+In order for Kubernetes components to show up in the service catalog
+as a part of an entity, Kubernetes components must be labeled with the following label:
+
+```yaml
+'backstage.io/kubernetes-id': <ENTITY_NAME>
+```

plugins/kubernetes/package.json

@@ -21,6 +21,7 @@
   },
   "dependencies": {
     "@backstage/catalog-model": "^0.1.1-alpha.24",
+    "@backstage/config": "^0.1.1-alpha.24",
     "@backstage/core": "^0.1.1-alpha.24",
     "@backstage/plugin-kubernetes-backend": "^0.1.1-alpha.24",
     "@backstage/theme": "^0.1.1-alpha.24",

plugins/kubernetes/src/api/KubernetesBackendClient.ts

@@ -16,7 +16,10 @@
 
 import { DiscoveryApi } from '@backstage/core';
 import { KubernetesApi } from './types';
-import { ObjectsByServiceIdResponse } from '@backstage/plugin-kubernetes-backend';
+import {
+  AuthRequestBody,
+  ObjectsByServiceIdResponse,
+} from '@backstage/plugin-kubernetes-backend';
 
 export class KubernetesBackendClient implements KubernetesApi {
   private readonly discoveryApi: DiscoveryApi;
@@ -25,9 +28,18 @@ export class KubernetesBackendClient implements KubernetesApi {
     this.discoveryApi = options.discoveryApi;
   }
 
-  private async getRequired(path: string): Promise<any> {
+  private async getRequired(
+    path: string,
+    requestBody: AuthRequestBody,
+  ): Promise<any> {
     const url = `${await this.discoveryApi.getBaseUrl('kubernetes')}${path}`;
-    const response = await fetch(url);
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(requestBody),
+    });
 
     if (!response.ok) {
       const payload = await response.text();
@@ -40,7 +52,8 @@ export class KubernetesBackendClient implements KubernetesApi {
 
   async getObjectsByServiceId(
     serviceId: String,
+    requestBody: AuthRequestBody,
   ): Promise<ObjectsByServiceIdResponse> {
-    return await this.getRequired(`/services/${serviceId}`);
+    return await this.getRequired(`/services/${serviceId}`, requestBody);
   }
 }

plugins/kubernetes/src/api/types.ts

@@ -15,7 +15,10 @@
  */
 
 import { createApiRef } from '@backstage/core';
-import { ObjectsByServiceIdResponse } from '@backstage/plugin-kubernetes-backend';
+import {
+  AuthRequestBody,
+  ObjectsByServiceIdResponse,
+} from '@backstage/plugin-kubernetes-backend';
 
 export const kubernetesApiRef = createApiRef<KubernetesApi>({
   id: 'plugin.kubernetes.service',
@@ -24,5 +27,8 @@ export const kubernetesApiRef = createApiRef<KubernetesApi>({
 });
 
 export interface KubernetesApi {
-  getObjectsByServiceId(serviceId: String): Promise<ObjectsByServiceIdResponse>;
+  getObjectsByServiceId(
+    serviceId: String,
+    requestBody: AuthRequestBody,
+  ): Promise<ObjectsByServiceIdResponse>;
 }

plugins/kubernetes/src/components/KubernetesContent/ErrorPanel.test.tsx

@@ -76,7 +76,7 @@ describe('ErrorPanel', () => {
     expect(getByText('Cluster: THIS_CLUSTER')).toBeInTheDocument();
     expect(
       getByText(
-        "Error fetching Kubernetes resource: 'some/resource', error: SYSTEM_ERROR",
+        "Error fetching Kubernetes resource: 'some/resource', error: SYSTEM_ERROR, status code: 500",
       ),
     ).toBeInTheDocument();
   });

plugins/kubernetes/src/components/KubernetesContent/ErrorPanel.tsx

@@ -29,7 +29,7 @@ const clustersWithErrorsToErrorMessage = (
         {c.errors.map((e, j) => {
           return (
             <Typography variant="body2" key={j}>
-              {`Error fetching Kubernetes resource: '${e.resourcePath}', error: ${e.errorType}`}
+              {`Error fetching Kubernetes resource: '${e.resourcePath}', error: ${e.errorType}, status code: ${e.statusCode}`}
             </Typography>
           );
         })}

plugins/kubernetes/src/components/KubernetesContent/KubernetesContent.tsx

@@ -16,8 +16,10 @@
 
 import React, { ReactElement, useEffect, useState } from 'react';
 import { Grid, TabProps } from '@material-ui/core';
+import { Config } from '@backstage/config';
 import {
   CardTab,
+  configApiRef,
   Content,
   Page,
   pageTheme,
@@ -28,10 +30,12 @@ import {
 import { Entity } from '@backstage/catalog-model';
 import { kubernetesApiRef } from '../../api/types';
 import {
+  AuthRequestBody,
   ClusterObjects,
   FetchResponse,
   ObjectsByServiceIdResponse,
 } from '@backstage/plugin-kubernetes-backend';
+import { kubernetesAuthProvidersApiRef } from '../../kubernetes-auth-provider/types';
 import { DeploymentTables } from '../DeploymentTables';
 import { DeploymentTriple } from '../../types/types';
 import {
@@ -105,16 +109,40 @@ export const KubernetesContent = ({ entity }: KubernetesContentProps) => {
   >(undefined);
   const [error, setError] = useState<string | undefined>(undefined);
 
+  const configApi = useApi(configApiRef);
+  const clusters: Config[] = configApi.getConfigArray('kubernetes.clusters');
+  const allAuthProviders: string[] = clusters.map(c =>
+    c.getString('authProvider'),
+  );
+  const authProviders: string[] = [...new Set(allAuthProviders)];
+
+  const kubernetesAuthProvidersApi = useApi(kubernetesAuthProvidersApiRef);
+
   useEffect(() => {
-    kubernetesApi
-      .getObjectsByServiceId(entity.metadata.name)
-      .then(result => {
-        setKubernetesObjects(result);
-      })
-      .catch(e => {
-        setError(e.message);
-      });
-  }, [entity.metadata.name, kubernetesApi]);
+    (async () => {
+      // For each auth type, invoke decorateRequestBodyForAuth on corresponding KubernetesAuthProvider
+      let requestBody: AuthRequestBody = {};
+      for (const authProviderStr of authProviders) {
+        // Multiple asyncs done sequentially instead of all at once to prevent same requestBody from being modified simultaneously
+        requestBody = await kubernetesAuthProvidersApi.decorateRequestBodyForAuth(
+          authProviderStr,
+          requestBody,
+        );
+      }
+
+      // TODO: Add validation on contents/format of requestBody
+      kubernetesApi
+        .getObjectsByServiceId(entity.metadata.name, requestBody)
+        .then(result => {
+          setKubernetesObjects(result);
+        })
+        .catch(e => {
+          setError(e.message);
+        });
+    })();
+    /* eslint-disable react-hooks/exhaustive-deps */
+  }, [entity.metadata.name, kubernetesApi, kubernetesAuthProvidersApi]);
+  /* eslint-enable react-hooks/exhaustive-deps */
 
   const clustersWithErrors =
     kubernetesObjects?.items.filter(r => r.errors.length > 0) ?? [];

plugins/kubernetes/src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { OAuthApi } from '@backstage/core';
+import { KubernetesAuthProvider } from './types';
+import { AuthRequestBody } from '@backstage/plugin-kubernetes-backend';
+
+export class GoogleKubernetesAuthProvider implements KubernetesAuthProvider {
+  authProvider: OAuthApi;
+
+  constructor(authProvider: OAuthApi) {
+    this.authProvider = authProvider;
+  }
+
+  async decorateRequestBodyForAuth(
+    requestBody: AuthRequestBody,
+  ): Promise<AuthRequestBody> {
+    const googleAuthToken: string = await this.authProvider.getAccessToken(
+      'https://www.googleapis.com/auth/cloud-platform',
+    );
+    if ('auth' in requestBody) {
+      requestBody.auth!.google = googleAuthToken;
+    } else {
+      requestBody.auth = { google: googleAuthToken };
+    }
+    return requestBody;
+  }
+}

plugins/kubernetes/src/kubernetes-auth-provider/KubernetesAuthProviders.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { OAuthApi } from '@backstage/core';
+import { AuthRequestBody } from '@backstage/plugin-kubernetes-backend';
+import { KubernetesAuthProvider, KubernetesAuthProvidersApi } from './types';
+import { GoogleKubernetesAuthProvider } from './GoogleKubernetesAuthProvider';
+import { ServiceAccountKubernetesAuthProvider } from './ServiceAccountKubernetesAuthProvider';
+
+export class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
+  private readonly kubernetesAuthProviderMap: Map<
+    string,
+    KubernetesAuthProvider
+  >;
+
+  constructor(options: { googleAuthApi: OAuthApi }) {
+    this.kubernetesAuthProviderMap = new Map<string, KubernetesAuthProvider>();
+    this.kubernetesAuthProviderMap.set(
+      'google',
+      new GoogleKubernetesAuthProvider(options.googleAuthApi),
+    );
+    this.kubernetesAuthProviderMap.set(
+      'serviceAccount',
+      new ServiceAccountKubernetesAuthProvider(),
+    );
+  }
+
+  async decorateRequestBodyForAuth(
+    authProvider: string,
+    requestBody: AuthRequestBody,
+  ): Promise<AuthRequestBody> {
+    const kubernetesAuthProvider:
+      | KubernetesAuthProvider
+      | undefined = this.kubernetesAuthProviderMap.get(authProvider);
+    if (kubernetesAuthProvider) {
+      return await kubernetesAuthProvider.decorateRequestBodyForAuth(
+        requestBody,
+      );
+    }
+    throw new Error(
+      `authProvider "${authProvider}" has no KubernetesAuthProvider defined for it`,
+    );
+  }
+}

plugins/kubernetes/src/kubernetes-auth-provider/ServiceAccountKubernetesAuthProvider.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { KubernetesAuthProvider } from './types';
+import { AuthRequestBody } from '@backstage/plugin-kubernetes-backend';
+
+export class ServiceAccountKubernetesAuthProvider
+  implements KubernetesAuthProvider {
+  async decorateRequestBodyForAuth(
+    requestBody: AuthRequestBody,
+  ): Promise<AuthRequestBody> {
+    // No-op, with service account for auth, cluster config/details should already have serviceAccountToken
+    return requestBody;
+  }
+}

plugins/kubernetes/src/kubernetes-auth-provider/types.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createApiRef } from '@backstage/core';
+import { AuthRequestBody } from '@backstage/plugin-kubernetes-backend';
+
+export interface KubernetesAuthProvider {
+  decorateRequestBodyForAuth(
+    requestBody: AuthRequestBody,
+  ): Promise<AuthRequestBody>;
+}
+
+export const kubernetesAuthProvidersApiRef = createApiRef<
+  KubernetesAuthProvidersApi
+>({
+  id: 'plugin.kubernetes-auth-providers.service',
+  description: 'Used by the Kubernetes plugin to fetch KubernetesAuthProviders',
+});
+
+export interface KubernetesAuthProvidersApi {
+  decorateRequestBodyForAuth(
+    authProvider: string,
+    requestBody: AuthRequestBody,
+  ): Promise<AuthRequestBody>;
+}

plugins/kubernetes/src/plugin.ts

@@ -18,9 +18,12 @@ import {
   createPlugin,
   createRouteRef,
   discoveryApiRef,
+  googleAuthApiRef,
 } from '@backstage/core';
 import { KubernetesBackendClient } from './api/KubernetesBackendClient';
 import { kubernetesApiRef } from './api/types';
+import { kubernetesAuthProvidersApiRef } from './kubernetes-auth-provider/types';
+import { KubernetesAuthProviders } from './kubernetes-auth-provider/KubernetesAuthProviders';
 
 export const rootCatalogKubernetesRouteRef = createRouteRef({
   path: '*',
@@ -36,5 +39,12 @@ export const plugin = createPlugin({
       factory: ({ discoveryApi }) =>
         new KubernetesBackendClient({ discoveryApi }),
     }),
+    createApiFactory({
+      api: kubernetesAuthProvidersApiRef,
+      deps: { googleAuthApi: googleAuthApiRef },
+      factory: ({ googleAuthApi }) => {
+        return new KubernetesAuthProviders({ googleAuthApi });
+      },
+    }),
   ],
 });