feat(integrations): New CircleCI Context Sync

2026-10-14 21:51:56 +00:00 · 2024-12-10 20:07:23 +01:00
parent c648235390
commit cc3d132f5d
16 changed files with 633 additions and 2 deletions
@@ -16,6 +16,7 @@ const integrationSlugNameMapping: Mapping = {
  railway: "Railway",
  flyio: "Fly.io",
  circleci: "CircleCI",
+  "circleci-context": "CircleCI Context",
  databricks: "Databricks",
  travisci: "TravisCI",
  supabase: "Supabase",
@@ -7,6 +7,7 @@ export {
  useGetIntegrationAuthBitBucketWorkspaces,
  useGetIntegrationAuthById,
  useGetIntegrationAuthChecklyGroups,
+  useGetIntegrationAuthCircleCIOrganizations,
  useGetIntegrationAuthGithubEnvs,
  useGetIntegrationAuthGithubOrgs,
  useGetIntegrationAuthNorthflankSecretGroups,
@@ -8,6 +8,7 @@ import {
  BitBucketEnvironment,
  BitBucketWorkspace,
  ChecklyGroup,
+  CircleCIOrganization,
  Environment,
  HerokuPipelineCoupling,
  IntegrationAuth,
@@ -128,7 +129,9 @@ const integrationAuthKeys = {
    integrationAuthId,
    ...params
  }: TGetIntegrationAuthOctopusDeployScopeValuesDTO) =>
-    [{ integrationAuthId }, "getIntegrationAuthOctopusDeployScopeValues", params] as const
+    [{ integrationAuthId }, "getIntegrationAuthOctopusDeployScopeValues", params] as const,
+  getIntegrationAuthCircleCIOrganizations: (integrationAuthId: string) =>
+    [{ integrationAuthId }, "getIntegrationAuthCircleCIOrganizations"] as const
 };

 const fetchIntegrationAuthById = async (integrationAuthId: string) => {
@@ -510,6 +513,15 @@ const fetchIntegrationAuthOctopusDeployScopeValues = async ({
  return data;
 };

+const fetchIntegrationAuthCircleCIOrganizations = async (integrationAuthId: string) => {
+  const {
+    data: { organizations }
+  } = await apiRequest.get<{
+    organizations: CircleCIOrganization[];
+  }>(`/api/v1/integration-auth/${integrationAuthId}/circleci/organizations`);
+  return organizations;
+};
+
 export const useGetIntegrationAuthById = (integrationAuthId: string) => {
  return useQuery({
    queryKey: integrationAuthKeys.getIntegrationAuthById(integrationAuthId),
@@ -884,6 +896,13 @@ export const useGetIntegrationAuthTeamCityBuildConfigs = ({
  });
 };

+export const useGetIntegrationAuthCircleCIOrganizations = (integrationAuthId: string) => {
+  return useQuery({
+    queryKey: integrationAuthKeys.getIntegrationAuthCircleCIOrganizations(integrationAuthId),
+    queryFn: () => fetchIntegrationAuthCircleCIOrganizations(integrationAuthId)
+  });
+};
+
 export const useAuthorizeIntegration = () => {
  const queryClient = useQueryClient();

@@ -105,6 +105,11 @@ export enum OctopusDeployScope {
  // tenant, variable set
 }

+export type CircleCIOrganization = {
+  name: string;
+  slug: string;
+};
+
 export type TGetIntegrationAuthOctopusDeployScopeValuesDTO = {
  integrationAuthId: string;
  spaceId: string;
@@ -0,0 +1,101 @@
+import { useState } from "react";
+import Head from "next/head";
+import Image from "next/image";
+import Link from "next/link";
+import { useRouter } from "next/router";
+import { faArrowUpRightFromSquare, faBookOpen } from "@fortawesome/free-solid-svg-icons";
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+
+import { Button, Card, CardTitle, FormControl, Input } from "@app/components/v2";
+import { useSaveIntegrationAccessToken } from "@app/hooks/api";
+
+export default function CircleCIContextCreateIntegrationPage() {
+  const router = useRouter();
+  const { mutateAsync } = useSaveIntegrationAccessToken();
+
+  const [apiKey, setApiKey] = useState("");
+  const [apiKeyErrorText, setApiKeyErrorText] = useState("");
+  const [isLoading, setIsLoading] = useState(false);
+
+  const handleButtonClick = async () => {
+    try {
+      setApiKeyErrorText("");
+      if (apiKey.length === 0) {
+        setApiKeyErrorText("API Key cannot be blank");
+        return;
+      }
+
+      setIsLoading(true);
+
+      const integrationAuth = await mutateAsync({
+        workspaceId: localStorage.getItem("projectData.id"),
+        integration: "circleci-context",
+        accessToken: apiKey
+      });
+
+      setIsLoading(false);
+
+      router.push(`/integrations/circleci-context/create?integrationAuthId=${integrationAuth.id}`);
+    } catch (err) {
+      console.error(err);
+    }
+  };
+
+  return (
+    <div className="flex h-full w-full items-center justify-center">
+      <Head>
+        <title>Authorize CircleCI Context Integration</title>
+        <link rel="icon" href="/infisical.ico" />
+      </Head>
+      <Card className="mb-12 max-w-lg rounded-md border border-mineshaft-600">
+        <CardTitle
+          className="px-6 text-left text-xl"
+          subTitle="After adding your API Token, you will be prompted to set up an integration for a particular Infisical project and environment."
+        >
+          <div className="flex flex-row items-center">
+            <div className="flex items-center pb-0.5">
+              <Image
+                src="/images/integrations/Circle CI.png"
+                height={30}
+                width={30}
+                alt="CircleCI logo"
+              />
+            </div>
+            <span className="ml-1.5">CircleCI Context Integration </span>
+            <Link href="https://infisical.com/docs/integrations/cicd/circleci-context" passHref>
+              <a target="_blank" rel="noopener noreferrer">
+                <div className="ml-2 mb-1 inline-block cursor-default rounded-md bg-yellow/20 px-1.5 pb-[0.03rem] pt-[0.04rem] text-sm text-yellow opacity-80 hover:opacity-100">
+                  <FontAwesomeIcon icon={faBookOpen} className="mr-1.5" />
+                  Docs
+                  <FontAwesomeIcon
+                    icon={faArrowUpRightFromSquare}
+                    className="ml-1.5 mb-[0.07rem] text-xxs"
+                  />
+                </div>
+              </a>
+            </Link>
+          </div>
+        </CardTitle>
+        <FormControl
+          label="CircleCI API Token"
+          errorText={apiKeyErrorText}
+          isError={apiKeyErrorText !== "" ?? false}
+          className="px-6"
+        >
+          <Input placeholder="" value={apiKey} onChange={(e) => setApiKey(e.target.value)} />
+        </FormControl>
+        <Button
+          onClick={handleButtonClick}
+          colorSchema="primary"
+          variant="outline_bg"
+          className="mb-6 mt-2 ml-auto mr-6 w-min"
+          isLoading={isLoading}
+        >
+          Connect to CircleCI
+        </Button>
+      </Card>
+    </div>
+  );
+}
+
+CircleCIContextCreateIntegrationPage.requireAuth = true;
@@ -0,0 +1,245 @@
+import { useEffect } from "react";
+import { Controller, useForm } from "react-hook-form";
+import Image from "next/image";
+import Link from "next/link";
+import { useRouter } from "next/router";
+import { faArrowUpRightFromSquare, faBookOpen } from "@fortawesome/free-solid-svg-icons";
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import { zodResolver } from "@hookform/resolvers/zod";
+import { z } from "zod";
+
+import { createNotification } from "@app/components/notifications";
+import {
+  Button,
+  Card,
+  CardTitle,
+  FilterableSelect,
+  FormControl,
+  Input,
+  Spinner
+} from "@app/components/v2";
+import { useWorkspace } from "@app/context";
+import { useCreateIntegration } from "@app/hooks/api";
+import {
+  useGetIntegrationAuthApps,
+  useGetIntegrationAuthCircleCIOrganizations
+} from "@app/hooks/api/integrationAuth";
+
+const formSchema = z.object({
+  secretPath: z.string().default("/"),
+  sourceEnvironment: z.object({ name: z.string(), slug: z.string() }),
+  targetOrg: z.object({ name: z.string(), slug: z.string() }),
+  targetContext: z.object({ name: z.string(), appId: z.string() })
+});
+
+type TFormData = z.infer<typeof formSchema>;
+
+export default function CircleCIContextCreateIntegrationPage() {
+  const router = useRouter();
+  const { mutateAsync, isLoading: isCreatingIntegration } = useCreateIntegration();
+  const { currentWorkspace, isLoading: isProjectLoading } = useWorkspace();
+
+  const integrationAuthId = router.query.integrationAuthId as string;
+
+  const { watch, control, reset, handleSubmit } = useForm<TFormData>({
+    resolver: zodResolver(formSchema),
+    defaultValues: {
+      secretPath: "/",
+      sourceEnvironment: currentWorkspace?.environments[0]
+    }
+  });
+
+  const circleCiOrg = watch("targetOrg");
+
+  const { data: circleCIOrganizations, isLoading: isCircleCIOrganizationsLoading } =
+    useGetIntegrationAuthCircleCIOrganizations(integrationAuthId);
+
+  const { data: circleCIContexts } = useGetIntegrationAuthApps(
+    {
+      integrationAuthId,
+      workspaceSlug: circleCiOrg?.slug
+    },
+
+    { enabled: Boolean(circleCiOrg?.slug) }
+  );
+
+  const onSubmit = async ({
+    sourceEnvironment,
+    secretPath,
+    targetOrg,
+    targetContext
+  }: TFormData) => {
+    try {
+      await mutateAsync({
+        integrationAuthId,
+        isActive: true,
+        sourceEnvironment: sourceEnvironment.slug,
+        app: targetContext.name,
+        appId: targetContext.appId,
+        owner: targetOrg.slug,
+        secretPath
+      });
+
+      createNotification({
+        type: "success",
+        text: "Successfully created integration"
+      });
+      router.push(`/integrations/${currentWorkspace?.id}`);
+    } catch (err) {
+      createNotification({
+        type: "error",
+        text: "Failed to create integration"
+      });
+      console.error(err);
+    }
+  };
+
+  useEffect(() => {
+    if (!circleCIContexts || !circleCIOrganizations || !currentWorkspace) return;
+
+    reset({
+      targetOrg: circleCIOrganizations[0],
+      targetContext: circleCIContexts[0]
+    });
+  }, [circleCIOrganizations, circleCIContexts, currentWorkspace]);
+
+  if (isProjectLoading || isCircleCIOrganizationsLoading)
+    return (
+      <div className="flex h-full w-full items-center justify-center p-24">
+        <Spinner />
+      </div>
+    );
+
+  return (
+    <form
+      onSubmit={handleSubmit(onSubmit)}
+      className="flex h-full w-full items-center justify-center"
+    >
+      <Card className="max-w-lg rounded-md p-8 pt-4">
+        <CardTitle
+          className="w-full px-0 text-left text-xl"
+          subTitle="Choose which environment or folder in Infisical you want to sync to CircleCI environment variables."
+        >
+          <div className="flex w-full flex-row items-center justify-between">
+            <div className="flex flex-row items-center gap-1.5">
+              <Image
+                src="/images/integrations/Circle CI.png"
+                height={30}
+                width={30}
+                alt="CircleCI logo"
+              />
+
+              <span className="">CircleCI Context Integration </span>
+            </div>
+
+            <Link
+              href="https://infisical.com/docs/integrations/cicd/circleci-context"
+              target="_blank"
+              rel="noopener noreferrer"
+              passHref
+            >
+              <div className="ml-2 mb-1 flex cursor-default cursor-pointer flex-row items-center gap-0.5 rounded-md bg-yellow/20 px-1.5 pb-[0.03rem] pt-[0.04rem] text-sm text-yellow opacity-80 hover:opacity-100">
+                <FontAwesomeIcon icon={faBookOpen} className="mr-1.5" />
+                Docs
+                <FontAwesomeIcon
+                  icon={faArrowUpRightFromSquare}
+                  className="ml-1.5 mb-[0.07rem] text-xxs"
+                />
+              </div>
+            </Link>
+          </div>
+        </CardTitle>
+        <Controller
+          control={control}
+          name="sourceEnvironment"
+          render={({ field: { value, onChange }, fieldState: { error } }) => (
+            <FormControl
+              errorText={error?.message}
+              isError={Boolean(error)}
+              label="Project Environment"
+            >
+              <FilterableSelect
+                getOptionValue={(option) => option.slug}
+                value={value}
+                getOptionLabel={(option) => option.name}
+                onChange={onChange}
+                options={currentWorkspace?.environments}
+                placeholder="Select a project environment"
+                isDisabled={!currentWorkspace?.environments.length}
+              />
+            </FormControl>
+          )}
+        />
+        <Controller
+          control={control}
+          name="secretPath"
+          render={({ field: { value, onChange }, fieldState: { error } }) => (
+            <FormControl isError={Boolean(error)} label="Secrets Path">
+              <Input
+                value={value}
+                onChange={onChange}
+                placeholder={'Provide a path (defaults to "/")'}
+              />
+            </FormControl>
+          )}
+        />
+        <Controller
+          control={control}
+          name="targetOrg"
+          render={({ field: { value, onChange }, fieldState: { error } }) => (
+            <FormControl
+              errorText={error?.message}
+              isError={Boolean(error)}
+              label="CircleCI Organization"
+            >
+              <FilterableSelect
+                getOptionValue={(option) => option.slug}
+                value={value}
+                getOptionLabel={(option) => option.name}
+                onChange={onChange}
+                options={circleCIOrganizations}
+                placeholder={
+                  circleCIOrganizations?.length
+                    ? "Select an organization..."
+                    : "No organizations found..."
+                }
+                isDisabled={!circleCIOrganizations?.length}
+              />
+            </FormControl>
+          )}
+        />
+        <Controller
+          control={control}
+          name="targetContext"
+          render={({ field: { value, onChange }, fieldState: { error } }) => (
+            <FormControl errorText={error?.message} isError={Boolean(error)} label="Bitbucket Repo">
+              <FilterableSelect
+                value={value}
+                getOptionValue={(option) => option.appId!}
+                getOptionLabel={(option) => option.name}
+                onChange={onChange}
+                options={circleCIContexts}
+                placeholder={
+                  circleCIContexts?.length ? "Select a context..." : "No contexts found..."
+                }
+                isDisabled={!circleCIContexts?.length}
+              />
+            </FormControl>
+          )}
+        />
+
+        <Button
+          type="submit"
+          colorSchema="primary"
+          className="mt-4"
+          isLoading={isCreatingIntegration}
+          isDisabled={isCreatingIntegration || !circleCIContexts?.length}
+        >
+          Create Integration
+        </Button>
+      </Card>
+    </form>
+  );
+}
+
+CircleCIContextCreateIntegrationPage.requireAuth = true;
@@ -46,6 +46,8 @@ export const IntegrationConnectionSection = ({ integration }: Props) => {
        case "qovery":
          return integration.scope;
        case "circleci":
+        case "circleci-context":
+          return "Context";
        case "terraform-cloud":
          return "Project";
        case "aws-secret-manager":
@@ -77,7 +79,6 @@ export const IntegrationConnectionSection = ({ integration }: Props) => {
            return `${integration.owner}`;
          }
          return `${integration.owner}/${integration.app}`;
-
        case "aws-parameter-store":
        case "rundeck":
          return `${integration.path}`;
@@ -155,6 +156,15 @@ export const IntegrationConnectionSection = ({ integration }: Props) => {
      );
    }

+    if (integration.integration === "circleci-context" && integration.owner) {
+      return (
+        <div>
+          <FormLabel className="text-sm font-semibold text-mineshaft-300" label="Organization" />
+          <div className="text-sm text-mineshaft-300">{integration.owner}</div>
+        </div>
+      );
+    }
+
    if (integration.integration === "terraform-cloud" && integration.targetService) {
      return (
        <div>
@@ -120,6 +120,9 @@ export const redirectForProviderAuth = (integrationOption: TCloudIntegration) =>
      case "circleci":
        link = `${window.location.origin}/integrations/circleci/authorize`;
        break;
+      case "circleci-context":
+        link = `${window.location.origin}/integrations/circleci-context/authorize`;
+        break;
      case "databricks":
        link = `${window.location.origin}/integrations/databricks/authorize`;
        break;
@@ -15,6 +15,7 @@ export const getIntegrationDestination = (integration: TIntegration) =>
  (["aws-parameter-store", "rundeck"].includes(integration.integration) && `${integration.path}`) ||
  (integration.scope?.startsWith("github-") && `${integration.owner}/${integration.app}`) ||
  integration.app ||
+  (integration.integration === "circleci-context" && `${integration.owner}`) ||
  "-";

 export const IntegrationDetails = ({ integration }: Props) => {
@@ -53,6 +54,7 @@ export const IntegrationDetails = ({ integration }: Props) => {
            label={
              (integration.integration === "qovery" && integration?.scope) ||
              (integration.integration === "circleci" && "Project") ||
+              (integration.integration === "circleci-context" && "Context") ||
              (integration.integration === "bitbucket" && "Repository") ||
              (integration.integration === "octopus-deploy" && "Project") ||
              (integration.integration === "aws-secret-manager" && "Secret") ||
@@ -110,6 +112,12 @@ export const IntegrationDetails = ({ integration }: Props) => {
          <div className={FIELD_CLASSNAME}>{integration.owner}</div>
        </div>
      )}
+      {integration.integration === "circleci-context" && integration.owner && (
+        <div>
+          <FormLabel label="Organization Slug" />
+          <div className={FIELD_CLASSNAME}>{integration.owner}</div>
+        </div>
+      )}
      {integration.integration === "terraform-cloud" && integration.targetService && (
        <div>
          <FormLabel label="Category" />