feat(vcs): defined the tag property under scm when lifting

for #9

src/index.js

@@ -1 +1,2 @@
 export {default as scaffold} from './scaffolder.js';
+export {lift} from './pom/index.js';

src/pom/index.js

@@ -1 +1,2 @@
 export {default as scaffold} from './scaffolder.js';
+export {default as lift} from './lifter.js';

src/pom/lifter.js

@@ -0,0 +1,13 @@
+import {promises as fs} from 'node:fs';
+import {XMLBuilder, XMLParser} from 'fast-xml-parser';
+
+export default async function ({projectRoot}) {
+  const pathToPom = `${projectRoot}/pom.xml`;
+  const parser = new XMLParser();
+  const builder = new XMLBuilder({format: true});
+  const existingPomContents = parser.parse(await fs.readFile(pathToPom, 'utf-8'));
+  existingPomContents.project.scm = {tag: 'HEAD'};
+  await fs.writeFile(pathToPom, builder.build(existingPomContents));
+
+  return {};
+}

src/pom/lifter.test.js

@@ -0,0 +1,34 @@
+import {promises as fs} from 'node:fs';
+
+import {describe, it, expect, vi, afterEach} from 'vitest';
+import any from '@travi/any';
+import {when} from 'jest-when';
+
+import liftPom from './lifter.js';
+
+vi.mock('node:fs');
+
+describe('pom lifter', () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should define the vcs details', async () => {
+    const projectRoot = any.string();
+    when(fs.readFile)
+      .calledWith(`${projectRoot}/pom.xml`, 'utf-8')
+      .mockResolvedValue('<project><modelVersion>4.0.0</modelVersion></project>');
+
+    expect(await liftPom({projectRoot})).toEqual({});
+    expect(fs.writeFile).toHaveBeenCalledWith(
+      `${projectRoot}/pom.xml`,
+      `<project>
+  <modelVersion>4.0.0</modelVersion>
+  <scm>
+    <tag>HEAD</tag>
+  </scm>
+</project>
+`
+    );
+  });
+});

test/integration/features/step_definitions/common-steps.js

@@ -7,11 +7,11 @@ import stubbedFs from 'mock-fs';
 const __dirname = dirname(fileURLToPath(import.meta.url));          // eslint-disable-line no-underscore-dangle
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
 
-let scaffold;
+let scaffold, lift;
 
 Before(async function () {
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
-  ({scaffold} = await import('@form8ion/java'));
+  ({scaffold, lift} = await import('@form8ion/java'));
 
   stubbedFs({
     node_modules: stubbedNodeModules
@@ -27,3 +27,7 @@ After(function () {
 When('the project is scaffolded', async function () {
   await scaffold({projectRoot: this.projectRoot, projectName: this.projectName});
 });
+
+When('the project is lifted', async function () {
+  await lift({projectRoot: this.projectRoot});
+});

test/integration/features/step_definitions/vcs-steps.js

@@ -0,0 +1,16 @@
+import {promises as fs} from 'node:fs';
+
+import {Given, Then} from '@cucumber/cucumber';
+import {XMLParser} from 'fast-xml-parser';
+import {assert} from 'chai';
+
+Given('vcs details are not defined in the pom', async function () {
+  await fs.writeFile(`${this.projectRoot}/pom.xml`, '<project><modelVersion>4.0.0</modelVersion></project>');
+});
+
+Then('vcs details are defined in the pom', async function () {
+  const parser = new XMLParser();
+  const {project: {scm}} = parser.parse(await fs.readFile(`${this.projectRoot}/pom.xml`, 'utf-8'));
+
+  assert.deepEqual(scm, {tag: 'HEAD'});
+});

test/integration/features/vcs.feature

@@ -0,0 +1,6 @@
+Feature: Version Control Details
+
+  Scenario: No Details Defined
+    Given vcs details are not defined in the pom
+    When the project is lifted
+    Then vcs details are defined in the pom