qa-faker-factory 1.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Azu Patrick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,321 @@
+# qa-faker-factory
+
+[![npm version](https://img.shields.io/npm/v/qa-faker-factory?color=brightgreen&label=npm)](https://www.npmjs.com/package/qa-faker-factory)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Test](https://github.com/azupatrick0/qa-faker-factory/actions/workflows/ci.yml/badge.svg)](https://github.com/azupatrick0/qa-faker-factory/actions/workflows/ci.yml)
+
+A comprehensive, lightweight test data factory generating realistic fake data for Quality Assurance (QA) and testing workflows.  
+Built on [faker-js/faker](https://github.com/faker-js/faker) to produce diverse domain-specific mock data objects for rapid testing and prototyping.
+
+---
+
+## Features
+
+- Generate fake **Users**, **Addresses**, **Products**, **Orders**, **Companies**, **Vehicles**, **Bank Accounts**, and more
+- Includes test data for specialized domains like **Medical Records**, **Travel Bookings**, **Support Tickets**, and **Subscription Plans**
+- Customizable options (e.g., country codes for phone numbers)
+- Lightweight and easy to integrate in Node.js projects
+- CLI and mock JSON data generation (planned / extendable)
+- Ideal for frontend, backend, and API testing
+
+---
+
+## Installation
+
+```bash
+npm install qa-faker-factory
+```
+
+---
+
+
+## Usage
+
+```js
+const {
+  generateUser,
+  generateAddress,
+  generateProduct,
+  generateOrder,
+  generateCompany,
+  generatePaymentCard,
+  generateVehicle,
+  generateBankAccount,
+  generateJobProfile,
+  generateEducationRecord,
+  generateSocialProfile,
+  generateMedicalRecord,
+  generateTravelBooking,
+  generateSupportTicket,
+  generateSubscriptionPlan,
+  generateChatMessage
+} = require('qa-faker-factory');
+
+// Generate a random user with default +1 country code for phone
+const user = generateUser();
+console.log(user);
+
+// Generate an address with a specified country
+const address = generateAddress({ country: 'United States' });
+console.log(address);
+
+// Generate an order with user's phone country code override
+const order = generateOrder({ countryCode: '+1' });
+console.log(order);
+```
+
+
+## API Reference
+```js
+generateUser(options) - Generate a random user object.
+
+Parameters:
+
+options (optional):
+
+countryCode (string) - Country dialing code for phone number (default: '+1')
+
+Returns:
+
+{
+  firstName: string,
+  lastName: string,
+  email: string,
+  phone: string, // formatted with countryCode
+  gender: 'Male' | 'Female' | 'Other'
+}
+```
+```js
+generateAddress(options) - Generate a random address.
+
+Parameters:
+
+options (optional):
+
+country (string) - Country name (default: 'United States')
+
+Returns:
+
+{
+  street: string,
+  city: string,
+  state: string,
+  postalCode: string,
+  country: string
+}
+```
+
+```js
+generateProduct() - Generate a random product.
+
+Returns:
+
+{
+  name: string,
+  price: string, // in Currency e.g ($)
+  category: string,
+  stock: number
+}
+```
+
+```js
+generateOrder(options) - Generate an order object including a user, product, quantity, and total price.
+
+Parameters:
+
+options (optional):
+
+countryCode (string) - Passed to generateUser to generate a user based on the country
+
+Returns:
+
+{
+  user: object,
+  product: object,
+  quantity: number,
+  total: string // total price string with currency symbol
+}
+```
+```js
+generateCompany() - Generate a random company.
+
+Returns:
+
+{
+  name: string,
+  catchPhrase: string,
+  industry: string,
+  website: string
+}
+```
+```js
+generatePaymentCard() - Generate a random payment card.
+
+Returns:
+
+{
+  type: string,
+  number: string,
+  cvv: string,
+  expiry: string // YYYY-MM-DD format
+}
+```
+
+```js
+generateVehicle() - Generate a vehicle profile.
+
+Returns:
+
+{
+  make: string,
+  model: string,
+  type: string,
+  vin: string,
+  registrationNumber: string
+}
+```
+```js
+generateBankAccount() - Generate a bank account.
+
+Returns:
+
+{
+  bankName: string,
+  accountNumber: string,
+  iban: string,
+  bic: string
+}
+```
+```js
+generateJobProfile() - Generate a job profile.
+
+Returns:
+
+{
+  title: string,
+  area: string,
+  type: string,
+  company: string
+}
+```
+```js
+generateEducationRecord() - Generate an education record.
+
+Returns:
+
+{
+  institution: string,
+  degree: string,
+  field: string,
+  graduationYear: number
+}
+```
+```js
+generateSocialProfile() - Generate a social media profile.
+
+Returns:
+
+{
+  username: string,
+  email: string,
+  avatar: string, // URL
+  url: string,
+  followers: number
+}
+```
+```js
+generateMedicalRecord() - Generate a medical record.
+
+Returns:
+
+{
+  patientId: string,
+  bloodType: string,
+  allergies: string[],
+  diagnosis: string,
+  lastVisit: string // YYYY-MM-DD format
+}
+```
+```js
+generateTravelBooking() - Generate a travel booking.
+
+Returns:
+
+{
+  destination: string,
+  departureDate: string, // YYYY-MM-DD
+  returnDate: string, // YYYY-MM-DD
+  airline: string,
+  bookingRef: string
+}
+```
+```js
+generateSupportTicket() - Generate a support ticket.
+
+Returns:
+
+{
+  ticketId: string,
+  subject: string,
+  status: 'open' | 'pending' | 'closed',
+  priority: 'low' | 'medium' | 'high',
+  createdAt: string // ISO timestamp
+}
+```
+```js
+generateSubscriptionPlan() - Generate a subscription plan.
+
+Returns:
+
+{
+  planName: string,
+  pricePerMonth: string, // e.g. "$19.99"
+  features: string[]
+}
+```
+```js
+generateChatMessage() - Generate a chat message.
+
+Returns: 
+
+{
+  messageId: string,
+  sender: string,
+  message: string,
+  timestamp: string // ISO timestamp
+}
+```
+
+---
+
+## Contributing
+
+
+Contributions are welcome! If you'd like to improve this project, follow these steps:
+
+- Fork the repository
+
+- Create a new branch 
+```js
+(git checkout -b feature-branch)
+```
+
+- Make your changes
+
+- Commit your changes
+
+```js
+(git commit -m 'Add new feature')
+```
+
+- Push to the branch (git push origin feature-branch)
+
+- Open a Pull Request
+
+Please make sure your code follows the existing style and includes relevant tests where applicable.
+
+---
+## License
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+You are free to use, modify, and distribute this software as permitted under the terms of the license.

package/__tests__/test-factory.test.js

@@ -0,0 +1,196 @@
+// __tests__/test-factory.test.js
+
+const {
+  generateUser,
+  generateAddress,
+  generateProduct,
+  generateOrder,
+  generateCompany,
+  generatePaymentCard,
+  generateVehicle,
+  generateBankAccount,
+  generateJobProfile,
+  generateEducationRecord,
+  generateSocialProfile,
+  generateMedicalRecord,
+  generateTravelBooking,
+  generateSupportTicket,
+  generateSubscriptionPlan,
+  generateChatMessage
+} = require('../index');
+
+describe('QA Faker Factory', () => {
+
+  test('generateUser produces expected properties', () => {
+    const user = generateUser({ countryCode: '+1' });
+    expect(user).toHaveProperty('firstName');
+    expect(user).toHaveProperty('lastName');
+    expect(user).toHaveProperty('email');
+    expect(user).toHaveProperty('phone');
+    expect(user.phone.startsWith('+1')).toBe(true);
+    expect(user).toHaveProperty('gender');
+  });
+
+  test('generateAddress produces expected properties', () => {
+    const address = generateAddress({ country: 'USA' });
+    expect(address).toHaveProperty('street');
+    expect(address).toHaveProperty('city');
+    expect(address).toHaveProperty('state');
+    expect(address).toHaveProperty('postalCode');
+    expect(address.country).toBe('USA');
+  });
+
+  test('generateProduct produces expected properties', () => {
+    const product = generateProduct();
+    expect(product).toHaveProperty('name');
+    expect(product).toHaveProperty('price');
+    expect(product.price).toMatch(/^₦\d+/);
+    expect(product).toHaveProperty('category');
+    expect(product).toHaveProperty('stock');
+  });
+
+  test('generateOrder produces expected properties and consistent total', () => {
+    const order = generateOrder({ countryCode: '+44' });
+    expect(order).toHaveProperty('user');
+    expect(order.user.phone.startsWith('+44')).toBe(true);
+    expect(order).toHaveProperty('product');
+    expect(order).toHaveProperty('quantity');
+    expect(order.quantity).toBeGreaterThanOrEqual(1);
+    expect(order.quantity).toBeLessThanOrEqual(5);
+    expect(order).toHaveProperty('total');
+
+    // Check total calculation is correct
+    const price = parseInt(order.product.price.replace('₦', ''), 10);
+    expect(order.total).toBe(`₦${price * order.quantity}`);
+  });
+
+  test('generateCompany produces expected properties', () => {
+    const company = generateCompany();
+    expect(company).toHaveProperty('name');
+    expect(company).toHaveProperty('catchPhrase');
+    expect(company).toHaveProperty('industry');
+    expect(company).toHaveProperty('website');
+  });
+
+  test('generatePaymentCard produces expected properties', () => {
+    const card = generatePaymentCard();
+    expect(card).toHaveProperty('type');
+    expect(card).toHaveProperty('number');
+    expect(card).toHaveProperty('cvv');
+    expect(card).toHaveProperty('expiry');
+    expect(new Date(card.expiry).getFullYear()).toBeGreaterThan(new Date().getFullYear());
+  });
+
+  test('generateVehicle produces expected properties', () => {
+    const vehicle = generateVehicle();
+    expect(vehicle).toHaveProperty('make');
+    expect(vehicle).toHaveProperty('model');
+    expect(vehicle).toHaveProperty('type');
+    expect(vehicle).toHaveProperty('vin');
+    expect(vehicle).toHaveProperty('registrationNumber');
+  });
+
+  test('generateBankAccount produces expected properties', () => {
+    const account = generateBankAccount();
+    expect(account).toHaveProperty('bankName');
+    expect(account).toHaveProperty('accountNumber');
+    expect(account).toHaveProperty('iban');
+    expect(account).toHaveProperty('bic');
+  });
+
+  test('generateJobProfile produces expected properties', () => {
+    const job = generateJobProfile();
+    expect(job).toHaveProperty('title');
+    expect(job).toHaveProperty('area');
+    expect(job).toHaveProperty('type');
+    expect(job).toHaveProperty('company');
+  });
+
+  test('generateEducationRecord produces expected properties', () => {
+
+    const education = generateEducationRecord();
+
+    expect(education).toHaveProperty('institution');
+    expect(typeof education.institution).toBe('string');
+
+    expect(education).toHaveProperty('degree');
+    expect(['B.Sc.', 'M.Sc.', 'Ph.D.', 'Diploma']).toContain(education.degree);
+
+    expect(education).toHaveProperty('fieldOfStudy');
+    expect(typeof education.fieldOfStudy).toBe('string');
+
+    expect(education).toHaveProperty('startDate');
+    expect(education.startDate instanceof Date).toBe(true);
+
+    expect(education).toHaveProperty('endDate');
+    expect(education.endDate instanceof Date).toBe(true);
+
+    expect(education).toHaveProperty('grade');
+    expect(['First Class', 'Second Class Upper', 'Second Class Lower', 'Pass']).toContain(education.grade);
+
+    expect(education).toHaveProperty('description');
+    expect(typeof education.description).toBe('string');
+    expect(education.description.length).toBeGreaterThan(0);
+
+    expect(education.endDate.getTime()).toBeGreaterThan(education.startDate.getTime());
+  });
+
+  test('generateSocialProfile produces expected properties', () => {
+    const social = generateSocialProfile();
+    expect(social).toHaveProperty('username');
+    expect(social).toHaveProperty('email');
+    expect(social).toHaveProperty('avatar');
+    expect(social).toHaveProperty('url');
+    expect(social).toHaveProperty('followers');
+  });
+
+  test('generateMedicalRecord produces expected properties', () => {
+    const medical = generateMedicalRecord();
+    expect(medical).toHaveProperty('patientId');
+    expect(medical).toHaveProperty('bloodType');
+    expect(['A+', 'A-', 'B+', 'B-', 'AB+', 'AB-', 'O+', 'O-']).toContain(medical.bloodType);
+    expect(medical).toHaveProperty('allergies');
+    expect(Array.isArray(medical.allergies)).toBe(true);
+    expect(medical).toHaveProperty('diagnosis');
+    expect(medical).toHaveProperty('lastVisit');
+  });
+
+  test('generateTravelBooking produces expected properties', () => {
+    const booking = generateTravelBooking();
+    expect(booking).toHaveProperty('destination');
+    expect(booking).toHaveProperty('departureDate');
+    expect(booking).toHaveProperty('returnDate');
+    expect(booking).toHaveProperty('airline');
+    expect(booking).toHaveProperty('bookingRef');
+  });
+
+  test('generateSupportTicket produces expected properties', () => {
+    const ticket = generateSupportTicket();
+    expect(ticket).toHaveProperty('ticketId');
+    expect(ticket).toHaveProperty('subject');
+    expect(ticket).toHaveProperty('status');
+    expect(['open', 'pending', 'closed']).toContain(ticket.status);
+    expect(ticket).toHaveProperty('priority');
+    expect(['low', 'medium', 'high']).toContain(ticket.priority);
+    expect(ticket).toHaveProperty('createdAt');
+  });
+
+  test('generateSubscriptionPlan produces expected properties', () => {
+    const plan = generateSubscriptionPlan();
+    expect(plan).toHaveProperty('planName');
+    expect(plan.planName).toMatch(/Plan$/);
+    expect(plan).toHaveProperty('pricePerMonth');
+    expect(plan.pricePerMonth).toMatch(/^\$\d+/);
+    expect(plan).toHaveProperty('features');
+    expect(Array.isArray(plan.features)).toBe(true);
+    expect(plan.features.length).toBeGreaterThan(0);
+  });
+
+  test('generateChatMessage produces expected properties', () => {
+    const msg = generateChatMessage();
+    expect(msg).toHaveProperty('messageId');
+    expect(msg).toHaveProperty('sender');
+    expect(msg).toHaveProperty('message');
+    expect(msg).toHaveProperty('timestamp');
+  });
+});

package/index.js

@@ -0,0 +1,181 @@
+// qa-faker-factory/index.js
+const { faker } = require('@faker-js/faker');
+
+function generateUser(options = {}) {
+  const countryCode = options.countryCode || '+1';
+  return {
+    firstName: faker.person.firstName(),
+    lastName: faker.person.lastName(),
+    email: faker.internet.email(),
+    phone: `${countryCode} ${faker.string.numeric(10)}`,
+    gender: faker.helpers.arrayElement(['Male', 'Female', 'Other'])
+  };
+}
+
+function generateAddress(options = {}) {
+  const country = options.country || faker.location.country();
+  return {
+    street: faker.location.streetAddress(),
+    city: faker.location.city(),
+    state: faker.location.state(),
+    postalCode: faker.location.zipCode(),
+    country
+  };
+}
+
+function generateProduct() {
+  return {
+    name: faker.commerce.productName(),
+    price: `₦${faker.commerce.price({ min: 1000, max: 20000, dec: 0 })}`,
+    category: faker.commerce.department(),
+    stock: faker.number.int({ min: 0, max: 500 })
+  };
+}
+
+function generateOrder(options = {}) {
+  const user = generateUser(options);
+  const product = generateProduct();
+  const quantity = faker.number.int({ min: 1, max: 5 });
+  return {
+    user,
+    product,
+    quantity,
+    total: `₦${parseInt(product.price.replace('₦', '')) * quantity}`
+  };
+}
+
+function generateCompany() {
+  return {
+    name: faker.company.name(),
+    catchPhrase: faker.company.catchPhrase(),
+    industry: faker.company.buzzNoun(),
+    website: faker.internet.url()
+  };
+}
+
+function generatePaymentCard() {
+  return {
+    type: faker.finance.creditCardIssuer(),
+    number: faker.finance.creditCardNumber(),
+    cvv: faker.finance.creditCardCVV(),
+    expiry: faker.date.future({ years: 3 }).toISOString().split('T')[0]
+  };
+}
+
+function generateVehicle() {
+  return {
+    make: faker.vehicle.manufacturer(),
+    model: faker.vehicle.model(),
+    type: faker.vehicle.type(),
+    vin: faker.vehicle.vin(),
+    registrationNumber: faker.string.alphanumeric(8).toUpperCase()
+  };
+}
+
+function generateBankAccount() {
+  return {
+    bankName: faker.finance.accountName(),
+    accountNumber: faker.finance.accountNumber(),
+    iban: faker.finance.iban(),
+    bic: faker.finance.bic()
+  };
+}
+
+function generateJobProfile() {
+  return {
+    title: faker.person.jobTitle(),
+    area: faker.person.jobArea(),
+    type: faker.person.jobType(),
+    company: faker.company.name()
+  };
+}
+
+function generateEducationRecord() {
+  return {
+    institution: faker.company.name(),
+    degree: faker.helpers.arrayElement(['B.Sc.', 'M.Sc.', 'Ph.D.', 'Diploma']),
+    fieldOfStudy: faker.person.jobArea(),
+    startDate: faker.date.past({ years: 10 }),
+    endDate: faker.date.recent(),
+    grade: faker.helpers.arrayElement(['First Class', 'Second Class Upper', 'Second Class Lower', 'Pass']),
+    description: faker.lorem.sentences(2)
+  };
+}
+
+function generateSocialProfile() {
+  return {
+    username: faker.internet.userName(),
+    email: faker.internet.email(),
+    avatar: faker.image.avatar(),
+    url: faker.internet.url(),
+    followers: faker.number.int({ min: 0, max: 100000 })
+  };
+}
+
+function generateMedicalRecord() {
+  return {
+    patientId: faker.string.uuid(),
+    bloodType: faker.helpers.arrayElement(['A+', 'A-', 'B+', 'B-', 'AB+', 'AB-', 'O+', 'O-']),
+    allergies: faker.helpers.arrayElements(['Penicillin', 'Peanuts', 'Latex', 'Bee stings', 'Dust'], 2),
+    diagnosis: faker.lorem.words(3),
+    lastVisit: faker.date.past().toISOString().split('T')[0]
+  };
+}
+
+function generateTravelBooking() {
+  return {
+    destination: faker.location.city(),
+    departureDate: faker.date.future().toISOString().split('T')[0],
+    returnDate: faker.date.future({ years: 1 }).toISOString().split('T')[0],
+    airline: faker.company.name(),
+    bookingRef: faker.string.alphanumeric(6).toUpperCase()
+  };
+}
+
+function generateSupportTicket() {
+  return {
+    ticketId: faker.string.uuid(),
+    subject: faker.lorem.sentence(),
+    status: faker.helpers.arrayElement(['open', 'pending', 'closed']),
+    priority: faker.helpers.arrayElement(['low', 'medium', 'high']),
+    createdAt: faker.date.past().toISOString()
+  };
+}
+
+function generateSubscriptionPlan() {
+  return {
+    planName: faker.commerce.productAdjective() + ' Plan',
+    pricePerMonth: `$${faker.commerce.price({ min: 5, max: 100, dec: 2 })}`,
+    features: faker.helpers.arrayElements([
+      'Unlimited access', 'Priority support', 'Custom reports', 'Team management', 'API access'
+    ], 3)
+  };
+}
+
+function generateChatMessage() {
+  return {
+    messageId: faker.string.uuid(),
+    sender: faker.internet.userName(),
+    message: faker.lorem.sentences(2),
+    timestamp: faker.date.recent().toISOString()
+  };
+}
+
+module.exports = {
+  generateUser,
+  generateAddress,
+  generateProduct,
+  generateOrder,
+  generateCompany,
+  generatePaymentCard,
+  generateVehicle,
+  generateBankAccount,
+  generateJobProfile,
+  generateEducationRecord,
+  generateSocialProfile,
+  generateMedicalRecord,
+  generateTravelBooking,
+  generateSupportTicket,
+  generateSubscriptionPlan,
+  generateChatMessage
+};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "qa-faker-factory",
+  "version": "1.0.0",
+  "description": "A lightweight test data factory for QA Engineers and Software Engineers based on @faker-js/faker",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "keywords": ["faker", "qa", "test-data", "mock", "factory", "automation"],
+  "author": "Patrick Azu <azupatrick0@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@faker-js/faker": "^8.4.1"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}