[CODE-16] Add git resource

Author: kevinwang5658

src/index.ts

@@ -3,6 +3,7 @@ import { Plugin, runPlugin } from 'codify-plugin-lib';
 import { AwsCliResource } from './resources/aws-cli/cli/aws-cli.js';
 import { AwsProfileResource } from './resources/aws-cli/profile/aws-profile.js';
 import { GitCloneResource } from './resources/git/clone/git-clone.js';
+import { GitResource } from './resources/git/git/git-resource.js';
 import { GitLfsResource } from './resources/git/lfs/git-lfs.js';
 import { HomebrewResource } from './resources/homebrew/homebrew.js';
 import { JenvResource } from './resources/java/jenv/jenv.js';
@@ -18,6 +19,7 @@ import { XcodeToolsResource } from './resources/xcode-tools/xcode-tools.js';
 runPlugin(Plugin.create(
   'default',
   [
+    new GitResource(),
     new XcodeToolsResource(),
     new PathResource(),
     new AliasResource(),

src/resources/aws-cli/profile/aws-profile.ts

@@ -28,6 +28,7 @@ export class AwsProfileResource extends Resource<AwsProfileConfig> {
         awsAccessKeyId: { modifyOnChange: true },
         awsSecretAccessKey: { modifyOnChange: true },
         csvCredentials: { transformParameter: new CSVCredentialsParameter() },
+        output: { default: 'json' },
         profile: { default: 'default' },
       },
       schema: Schema,

src/resources/git/git/git-email-paramater.ts

@@ -0,0 +1,25 @@
+import { StatefulParameter } from 'codify-plugin-lib';
+
+import { SpawnStatus, codifySpawn } from '../../../utils/codify-spawn.js';
+import { GitConfig } from './git-resource.js';
+
+export class GitEmailParameter extends StatefulParameter<GitConfig, string> {
+
+    async refresh(): Promise<null | string> {
+      const { data: email, status } = await codifySpawn('git config --global user.email', { throws: false })
+
+      return status === SpawnStatus.ERROR ? null : email.trim()
+    }
+
+    async applyAdd(valueToAdd: string): Promise<void> {
+      await codifySpawn(`git config --global user.email "${valueToAdd}"`)
+    }
+
+    async applyModify(newValue: string): Promise<void> {
+      await codifySpawn(`git config --global user.email "${newValue}"`)
+    }
+
+    async applyRemove(): Promise<void> {
+      await codifySpawn('git config --global --unset user.email')
+    }
+}

src/resources/git/git/git-name-parameter.ts

@@ -0,0 +1,25 @@
+import { StatefulParameter } from 'codify-plugin-lib';
+
+import { SpawnStatus, codifySpawn } from '../../../utils/codify-spawn.js';
+import { GitConfig } from './git-resource.js';
+
+export class GitNameParameter extends StatefulParameter<GitConfig, string> {
+
+  async refresh(): Promise<null | string> {
+    const { data: email, status } = await codifySpawn('git config --global user.name', { throws: false })
+
+    return status === SpawnStatus.ERROR ? null : email.trim()
+  }
+
+  async applyAdd(valueToAdd: string): Promise<void> {
+    await codifySpawn(`git config --global user.name "${valueToAdd}"`)
+  }
+
+  async applyModify(newValue: string): Promise<void> {
+    await codifySpawn(`git config --global user.name "${newValue}"`)
+  }
+
+  async applyRemove(): Promise<void> {
+    await codifySpawn('git config --global --unset user.name')
+  }
+}

src/resources/git/git/git-resource.ts

@@ -0,0 +1,38 @@
+import { CreatePlan, DestroyPlan, Resource } from 'codify-plugin-lib';
+import { StringIndexedObject } from 'codify-schemas';
+
+import { SpawnStatus, codifySpawn } from '../../../utils/codify-spawn.js';
+import { GitEmailParameter } from './git-email-paramater.js';
+import { GitNameParameter } from './git-name-parameter.js';
+
+export interface GitConfig extends StringIndexedObject {
+  email?: string,
+  username?: string,
+  // TODO: Allow upgrading git to the latest version in the future. This means installing git using homebrew
+}
+
+export class GitResource extends Resource<GitConfig> {
+  constructor() {
+    super({
+      callStatefulParameterRemoveOnDestroy: true,
+      parameterOptions: {
+        email: { statefulParameter: new GitEmailParameter(), },
+        username: { statefulParameter: new GitNameParameter() },
+      },
+      type: 'git'
+    });
+  }
+  
+  async refresh(): Promise<Partial<GitConfig> | null> {
+    const { status } = await codifySpawn('which git', { throws: false })
+    return status === SpawnStatus.ERROR ? null : {}
+  }
+
+  async applyCreate(): Promise<void> {
+    // Git should always be installed with xcode tools. Nothing to do here.
+  }
+
+  async applyDestroy(): Promise<void> {
+    // Don't uninstall git. It will break things.
+  }
+}

src/resources/git/git/git-schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codifycli.com/git.json",
+  "title": "Jenv resource",
+  "type": "object",
+  "properties": {
+    "email": {
+      "type": "string",
+      "description": "The global email to set for git"
+    },
+    "username": {
+      "type": "string",
+      "description": "The global username to set for git"
+    }
+  },
+  "additionalProperties": false
+}

src/resources/java/jenv/jenv-schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://www.codifycli.com/nvm.json",
-  "title": "Nvm resource",
+  "$id": "https://www.codifycli.com/jenv.json",
+  "title": "Jenv resource",
   "type": "object",
   "properties": {
     "add": {

test/git/git.test.ts

@@ -0,0 +1,35 @@
+import { afterEach, beforeEach, describe, it } from 'vitest';
+import { PluginTester } from 'codify-plugin-test';
+import * as path from 'node:path';
+
+describe('Git integration tests', async () => {
+  let plugin: PluginTester;
+
+  beforeEach(() => {
+    plugin = new PluginTester(path.resolve('./src/index.ts'));
+  })
+
+  it('Can add global user name and email', { timeout: 300000 }, async () => {
+    await plugin.fullTest([
+      {
+        type: 'git',
+        username: 'test',
+        email: 'test@test.com'
+      }
+    ]);
+  })
+
+  it('Can modify git user name and email', { timeout: 300000 }, async () => {
+    await plugin.fullTest([
+      {
+        type: 'git',
+        username: 'test2',
+        email: 'test2@test.com'
+      }
+    ]);
+  })
+
+  afterEach(() => {
+    plugin.kill();
+  })
+})