NestJS Enterprise Backend APIs · 강의

데이터베이스 시딩과 테스트

개발 및 테스트를 위해 초기 데이터로 데이터베이스를 채워 일관된 환경을 유지하는 방법을 학습합니다.

데이터베이스 시딩과 테스트은(는) CoddyKit의 무료 NestJS Enterprise Backend APIs 강의입니다. 이것은 3개 중 3번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 NestJS Enterprise Backend APIs 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. NestJS Enterprise Backend APIs 강의에는 총 3개의 강의가 포함되어 있습니다.

이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.

What is Database Seeding?

Imagine starting a new project or running tests. Your database is empty! Database seeding is the process of populating a database with initial data.

This data can be anything from default user accounts to sample product listings. It's crucial for development, testing, and even for setting up a production environment with essential configuration data.

Benefits of Seeding

Seeding offers several key advantages:

Consistent Environments: Ensures everyone on the team, and your CI/CD pipeline, works with the same baseline data.
Faster Development: Developers don't waste time manually entering test data.
Reliable Testing: Tests run against predictable data, making results more trustworthy.
Easier Onboarding: New team members can quickly set up their local environment with meaningful data.

NestJS & TypeORM Seeding

In a NestJS application using TypeORM, seeding typically involves creating dedicated scripts that interact with your TypeORM entities and repositories.

While TypeORM itself has a CLI for migrations, for seeding, you often create custom scripts that can be run on demand. These scripts use TypeORM's EntityManager or specific repositories to insert data.

Crafting a Simple Seeder

Let's look at a conceptual example of a seeder script. This script would usually live in a src/database/seeds directory and be executed via a custom npm script.

It uses TypeORM's Repository to create and save a new user, ensuring the data is persisted correctly.

// src/database/seeds/user.seeder.ts
import { DataSource } from 'typeorm';
import { User } from '../../users/user.entity';
import { Seeder, SeederFactoryManager } from 'typeorm-extension';

export default class UserSeeder implements Seeder {
  public async run(
    dataSource: DataSource,
    factoryManager: SeederFactoryManager
  ): Promise<any> {
    const userRepository = dataSource.getRepository(User);

    // Check if user already exists to prevent duplicates
    let adminUser = await userRepository.findOneBy({ email: 'admin@example.com' });

    if (!adminUser) {
      adminUser = userRepository.create({
        firstName: 'Admin',
        lastName: 'User',
        email: 'admin@example.com',
        password: 'securePassword123', // In real app, hash this!
      });
      await userRepository.save(adminUser);
      console.log('Admin user seeded.');
    } else {
      console.log('Admin user already exists.');
    }
  }
}

Executing Seeder Scripts

To run your seeders, you typically add a custom script to your package.json. You might use ts-node to execute TypeScript files directly, or compile them first.

A common setup involves a typeorm-extension library which provides a more structured way to manage and run seeders, similar to how migrations are handled.

// package.json snippets
{
  "scripts": {
    "seed:run": "ts-node -r tsconfig-paths/register ./node_modules/typeorm-extension/dist/cli/index.js seed -d src/config/typeorm.config.ts"
  }
}

Development Data

For development, seeding often means populating your database with a good amount of realistic-looking data. This helps you test UI components, pagination, and search functionality without manually creating hundreds of entries.

You might use libraries like Faker.js (or @faker-js/faker) within your seeders to generate diverse and random data for users, products, posts, etc.

Test-Specific Data

When it comes to testing, seeding takes on a more precise role. You often need very specific, controlled datasets for your unit and integration tests.

For example, a test for a login feature might only need one specific user record, not hundreds. This ensures your tests are deterministic and don't break due to unexpected data.

Seeding in Test Workflows

To ensure a clean slate for each test run, it's a common practice to run seeders before or after your tests. Jest, a popular testing framework, allows you to define setup and teardown functions.

You could use beforeEach or beforeAll to execute a seeding script, ensuring your database is in a known state before tests begin.

// Conceptual test file snippet
import { INestApplication } from '@nestjs/common';
import { Test } from '@nestjs/testing';
import { AppModule } from './app.module';
import { DataSource } from 'typeorm';
import UserSeeder from './database/seeds/user.seeder'; // Your seeder

describe('UsersController (e2e)', () => {
  let app: INestApplication;
  let dataSource: DataSource;

  beforeAll(async () => {
    const moduleFixture = await Test.createTestingModule({
      imports: [AppModule],
    }).compile();

    app = moduleFixture.createNestApplication();
    await app.init();
    
    // Get TypeORM DataSource
    dataSource = app.get(DataSource);
  });

  beforeEach(async () => {
    // Clear database and run specific seeders before each test
    await dataSource.synchronize(true); // CAUTION: Clears all data! Use carefully.
    await new UserSeeder().run(dataSource, null); // Run your seeder
  });

  afterAll(async () => {
    await app.close();
  });

  it('/users (GET) should return seeded users', () => {
    // Test logic here, expecting seeded data
  });
});

Key Seeding Practices

Follow these tips for robust seeding:

Idempotency: Ensure running a seeder multiple times doesn't create duplicate data unless intended. Check for existing records first.
Clear Separation: Keep development seeders (lots of dummy data) separate from testing seeders (minimal, precise data).
Version Control: Store seeders in your version control system.
Environment-Specific: Be cautious when running seeders in production. Only seed essential config data.

Seeding Benefits

Database seeding provides significant advantages for development and testing.

Which of the following are primary benefits of database seeding?

Recap: Seeding for Success

Congratulations! You've learned about database seeding, a vital practice for any backend developer.

We covered what seeding is, its benefits for development and testing, and how to implement and run seeders in a NestJS/TypeORM application. You also saw how to integrate seeding into your test workflows.

By mastering seeding, you ensure consistent, reliable, and efficient development and testing cycles!

자주 묻는 질문

“데이터베이스 시딩과 테스트” 강의는 무료인가요?

네 — “데이터베이스 시딩과 테스트” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 NestJS Enterprise Backend APIs 강의 전체를 잠금 해제할 수 있습니다. NestJS Enterprise Backend APIs 강의에는 총 3개의 강의가 포함되어 있습니다.

“데이터베이스 시딩과 테스트”에서 뭘 배우나요?

개발 및 테스트를 위해 초기 데이터로 데이터베이스를 채워 일관된 환경을 유지하는 방법을 학습합니다. 브라우저에서 직접 실행하는 실습 코드로 NestJS Enterprise Backend APIs을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

NestJS Enterprise Backend APIs을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 NestJS Enterprise Backend APIs은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 3개 중 3번째 강의입니다.

“데이터베이스 시딩과 테스트” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 NestJS Enterprise Backend APIs 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 NestJS Enterprise Backend APIs 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← NestJS Enterprise Backend APIs(으)로 돌아가기