feat: Add ESM support, improve code quality, and enhance test coverage (#124)

* Initial plan

* Implement codeceptjs-testrail improvements: ESM support, code quality, and enhanced tests

Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kobenguyent <7845001+kobenguyent@users.noreply.github.com>

Author: Copilot

index.mjs

@@ -0,0 +1,4 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const testrailPlugin = require('./index.js');
+export default testrailPlugin;

lib/testrail.js

@@ -11,7 +11,7 @@ class TestRail {
 		this.password = defaultConfig.password;
 		this.uri = '/index.php?/api/v2/';
 
-		const b = new Buffer(`${this.user}:${this.password}`);
+		const b = Buffer.from(`${this.user}:${this.password}`);
 		const basicAuth = b.toString('base64');
 
 		this.axios = axios.create({

package.json

@@ -3,6 +3,13 @@
   "version": "1.12.0",
   "description": "CodeceptJS plugin for TestRail",
   "main": "index.js",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/KobeNguyenT/codeceptjs-testrail.git"
@@ -27,6 +34,9 @@
   "scripts": {
     "lint": "eslint .",
     "lint-fix": "eslint . --fix",
+    "test": "npm run test:unit && npm run test:esm && npm run acceptance_test",
+    "test:unit": "mocha test/unit_test.js --timeout 6000",
+    "test:esm": "mocha test/esm_test.mjs --timeout 6000",
     "test-server": "json-server test/db.json --routes test/routes.json &",
     "acceptance_test": "mocha test/acceptance_test.js --timeout 6000",
     "semantic-release": "semantic-release"
@@ -46,6 +56,7 @@
   },
   "files": [
     "lib/*",
-    "index.js"
+    "index.js",
+    "index.mjs"
   ]
 }

readme.md

@@ -12,6 +12,14 @@
 
 Testrail CodeceptJS Integration. The test run is created automatically after the test execution. The screenshots of failed tests are also attached to test results.
 
+**Features:**
+- ✅ Support for both **CommonJS** and **ES Modules (ESM)**
+- ✅ Automatic test run creation  
+- ✅ Screenshot attachment for failed tests
+- ✅ Configuration support for test plans
+- ✅ Result processor for custom field handling
+- ✅ Worker support for parallel execution
+
 ![Attachemnt for failed case](http://g.recordit.co/ajaa2QRlnW.gif)
 
 New feature, add the configuration to test run of test plan
@@ -25,6 +33,20 @@ Install to use this custom plugin
 npm i codeceptjs-testrail --save
 ```
 
+### Module Support
+
+This plugin supports both CommonJS and ES Modules:
+
+**CommonJS (require):**
+```js
+const testrailPlugin = require('codeceptjs-testrail');
+```
+
+**ES Modules (import):**
+```js
+import testrailPlugin from 'codeceptjs-testrail';
+```
+
 **Note:**
 
 - You should provide the test case id to make it works, otherwise, this plugin has no clue which case id to be added to test run on Testrail.
@@ -96,7 +118,10 @@ TestRail tag in **Examples** from **Scenario Outline** available from version `1
 
 Add this plugin to config file:
 
+### CommonJS Configuration
+
 ```js
+// codecept.conf.js
 // ...
 plugins: {
   // ...
@@ -145,6 +170,30 @@ plugins: {
 // ...
 ```
 
+### ESM Configuration
+
+```js
+// codecept.conf.mjs
+import testrailPlugin from 'codeceptjs-testrail';
+
+// ...
+plugins: {
+  // ...
+  testrail: {
+    require: testrailPlugin,
+    host: 'https://kobenguyent.testrail.io',
+    user: 'username',
+    password: 'password or api key',
+    suiteId: 1,
+    projectId: 1,
+    runName: 'Custom run name',
+    // ... rest of configuration same as CommonJS
+  }
+  // ...
+}
+// ...
+```
+
 ### Possible config options:
 
 | config name           | required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
@@ -168,4 +217,13 @@ plugins: {
 
 ## Contributing
 
-[Read here](./.github/CONTRIBUTING.md)
+[Read here](./.github/CONTRIBUTING.md)
+
+## Changelog
+
+### Latest Improvements
+
+- ✅ **Added ESM Support**: The plugin now supports both CommonJS and ES Modules
+- ✅ **Code Quality**: Fixed deprecated `new Buffer()` usage, replaced with `Buffer.from()`  
+- ✅ **Enhanced Tests**: Added comprehensive unit tests for both CommonJS and ESM imports
+- ✅ **Better Documentation**: Updated README with ESM examples and improved configuration documentation

test/esm_test.mjs

@@ -0,0 +1,55 @@
+import pkg from 'chai';
+const { expect } = pkg;
+
+// Test ESM import
+import testrailPlugin from '../index.mjs';
+
+describe('CodeceptJS TestRail Plugin - ESM', () => {
+  const validConfig = {
+    host: 'https://test.testrail.io',
+    user: 'testuser',
+    password: 'testpass',
+    projectId: 1,
+    suiteId: 1,
+    enabled: true
+  };
+
+  describe('Module Export', () => {
+    it('should export a function', () => {
+      expect(testrailPlugin).to.be.a('function');
+    });
+
+    it('should return an object when called with valid config', () => {
+      const result = testrailPlugin(validConfig);
+      expect(result).to.be.an('object');
+    });
+  });
+
+  describe('Configuration Validation', () => {
+    it('should merge default config with provided config', () => {
+      // This test validates that the plugin doesn't throw with minimal valid config
+      expect(() => testrailPlugin(validConfig)).to.not.throw();
+    });
+
+    it('should validate result processor type', () => {
+      const invalidConfig = { ...validConfig, resultProcessor: 'invalid' };
+      expect(() => testrailPlugin(invalidConfig)).to.throw('Result processor (`resultProcessor` config option) has to be function');
+    });
+
+    it('should accept valid result processor function', () => {
+      const configWithProcessor = { 
+        ...validConfig, 
+        resultProcessor: (result) => result 
+      };
+      expect(() => testrailPlugin(configWithProcessor)).to.not.throw();
+    });
+  });
+
+  describe('ESM Module Compatibility', () => {
+    it('should work with ESM import syntax', () => {
+      expect(testrailPlugin).to.be.a('function');
+      const plugin = testrailPlugin(validConfig);
+      expect(plugin).to.be.an('object');
+    });
+  });
+});

test/unit_test.js

@@ -0,0 +1,54 @@
+const { expect } = require('chai');
+
+// Test CommonJS import
+const testrailPlugin = require('../index.js');
+
+describe('CodeceptJS TestRail Plugin - CommonJS', () => {
+	const validConfig = {
+		host: 'https://test.testrail.io',
+		user: 'testuser',
+		password: 'testpass',
+		projectId: 1,
+		suiteId: 1,
+		enabled: true
+	};
+
+	describe('Module Export', () => {
+		it('should export a function', () => {
+			expect(testrailPlugin).to.be.a('function');
+		});
+
+		it('should return an object when called with valid config', () => {
+			const result = testrailPlugin(validConfig);
+			expect(result).to.be.an('object');
+		});
+	});
+
+	describe('Configuration Validation', () => {
+		it('should merge default config with provided config', () => {
+			// This test validates that the plugin doesn't throw with minimal valid config
+			expect(() => testrailPlugin(validConfig)).to.not.throw();
+		});
+
+		it('should validate result processor type', () => {
+			const invalidConfig = { ...validConfig, resultProcessor: 'invalid' };
+			expect(() => testrailPlugin(invalidConfig)).to.throw('Result processor (`resultProcessor` config option) has to be function');
+		});
+
+		it('should accept valid result processor function', () => {
+			const configWithProcessor = { 
+				...validConfig, 
+				resultProcessor: (result) => result 
+			};
+			expect(() => testrailPlugin(configWithProcessor)).to.not.throw();
+		});
+	});
+
+	describe('Default Configuration', () => {
+		it('should have correct default values', () => {
+			// Test that plugin accepts config and doesn't throw
+			const plugin = testrailPlugin(validConfig);
+			expect(plugin).to.be.an('object');
+		});
+	});
+});