debian-mirror-gitlab/doc/topics/awesome_co.md

stage	group	info	description
Manage	Foundations	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments	AwesomeCo test data harness created by the Test Data Working Group https://about.gitlab.com/company/team/structure/working-groups/demo-test-data/

AwesomeCo

AwesomeCo is a test data seeding harness, that can seed test data into a user or group namespace.

AwesomeCo uses FactoryBot in the backend which makes maintenance extremely easy. When a Model is changed, FactoryBot will already be reflected to account for the change.

Docker Setup

See AwesomeCo Docker Demo

GDK Setup

$ gdk start db
ok: run: services/postgresql: (pid n) 0s, normally down
ok: run: services/redis: (pid n) 74s, normally down
$ bundle install
Bundle complete!
$ bundle exec rake db:migrate
main: migrated
ci: migrated

Run

The ee:gitlab:seed:awesome_co Rake task takes two arguments. :name and :namespace_id.

$ bundle exec rake "ee:gitlab:seed:awesome_co[awesome_co,1]"
Seeding AwesomeCo for Administrator

:name

Where :name is the name of the AwesomeCo. (This will reflect .rb files located in db/seeds/awesome_co/*.rb)

:namespace_id

Where :namespace_id is the ID of the User or Group Namespace

List of Awesome Companies

Each company (i.e. test data template) is represented as a Ruby file (.rb) in db/seeds/awesome_co.

AwesomeCo (db/seeds/awesome_co/awesome_co.rb)

$ bundle exec rake "ee:gitlab:seed:awesome_co[awesome_co,:namespace_id]"
Seeding AwesomeCo for :namespace_id

AwesomeCo is an automated seeding of this demo repository.

Develop

AwesomeCo seeding uses FactoryBot definitions from spec/factories which ...

1. Saves time on development
2. Are easy-to-read
3. Are easy to maintain
4. Do not rely on an API that may change in the future
5. Are always up-to-date
6. Execute on the lowest-level (ActiveRecord) possible to create data as quickly as possible

From the FactoryBot README : factory_bot is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class, including factory inheritance

Factories reside in spec/factories/* and are fixtures for Rails models found in app/models/*. For example, For a model named app/models/issue.rb, the factory will be named spec/factories/issues.rb. For a model named app/models/project.rb, the factory will be named app/models/projects.rb.

Taxonomy of a Factory

Factories consist of three main parts - the Name of the factory, the Traits and the Attributes.

Given: create(:iteration, :with_title, :current, title: 'My Iteration')

:iteration	This is the Name of the factory. The file name will be the plural form of this Name and reside under either spec/factories/iterations.rb or ee/spec/factories/iterations.rb.
:with_title	This is a Trait of the factory. See how it's defined.
:current	This is a Trait of the factory. See how it's defined.
title: 'My Iteration'	This is an Attribute of the factory that will be passed to the Model for creation.

Examples

In these examples, you will see an instance variable @owner. This is the root user (User.first).

Create a Group

my_group = create(:group, name: 'My Group', path: 'my-group-path')

Create a Project

# create a Project belonging to a Group
my_project = create(:project, :public, name: 'My Project', namespace: my_group, creator: @owner)

Create an Issue

# create an Issue belonging to a Project
my_issue = create(:issue, title: 'My Issue', project: my_project, weight: 2)

Create an Iteration

# create an Iteration under a Group
my_iteration = create(:iteration, :with_title, :current, title: 'My Iteration', group: my_group)

Frequently encountered issues

ActiveRecord::RecordInvalid: Validation failed: Email has already been taken, Username has already been taken

This is because, by default, our factories are written to backfill any data that is missing. For instance, when a project is created, the project must have somebody that created it. If the owner is not specified, the factory attempts to create it.

How to fix

Check the respective Factory to find out what key is required. Usually :author or :owner.

# This throws ActiveRecord::RecordInvalid
create(:project, name: 'Throws Error', namespace: create(:group, name: 'Some Group'))

# Specify the user where @owner is a [User] record
create(:project, name: 'No longer throws error', owner: @owner, namespace: create(:group, name: 'Some Group'))
create(:epic, group: create(:group), author: @owner)

parsing id "my id" as "my_id"

See specifying variables

id is invalid

Given that non-Ruby parsers parse IDs as Ruby Objects, the naming conventions of Ruby must be followed when specifying an ID.

Examples of invalid IDs:

• IDs that start with a number
• IDs that have special characters (-, !, $, @, `, =, <, >, ;, :)

ActiveRecord::AssociationTypeMismatch: Model expected, got ... which is an instance of String

This is currently a limitation for the seeder.

See the issue for allowing parsing of raw Ruby objects.

YAML Factories

Generator to generate n amount of records

Group Labels

group_labels:
  # Group Label with Name and a Color
  - name: Group Label 1
    group_id: <%= @group.id %>
    color: "#FF0000"

Group Milestones

group_milestones:
  # Past Milestone
  - name: Past Milestone
    group_id: <%= @group.id %>
    group:
    start_date: <%= 1.month.ago %>
    due_date: <%= 1.day.ago %>

  # Ongoing Milestone
  - name: Ongoing Milestone
    group_id: <%= @group.id %>
    group:
    start_date: <%= 1.day.ago %>
    due_date: <%= 1.month.from_now %>

  # Future Milestone
  - name: Ongoing Milestone
    group_id: <%= @group.id %>
    group:
    start_date: <%= 1.month.from_now %>
    due_date: <%= 2.months.from_now %>

Quirks

• You must specify group: and have it be empty. This is because the Milestones factory will manipulate the factory in an after(:build). If this is not present, the Milestone will not be associated properly with the Group.

Epics

epics:
  # Simple Epic
  - title: Simple Epic
    group_id: <%= @group.id %>
    author_id: <%= @owner.id %>

  # Epic with detailed Markdown description
  - title: Detailed Epic
    group_id: <%= @group.id %>
    author_id: <%= @owner.id %>
    description: |
      # Markdown

      **Description**      

  # Epic with dates
  - title: Epic with dates
    group_id: <%= @group.id %>
    author_id: <%= @owner.id %>
    start_date: <%= 1.day.ago %>
    due_date: <%= 1.month.from_now %>

Variables

Each created factory can be assigned an identifier to be used in future seeding.

You can specify an ID for any created factory that you may use later in the seed file.

Specify a variable

You may pass an _id attribute on any factory to refer back to it later in non-Ruby parsers.

Variables are under the factory definitions that they reside in.

---
group_labels:
  - _id: my_label #=> group_labels.my_label

projects:
  - _id: my_project #=> projects.my_project

Variables:

NOTE: It is not advised, but you may specify variables with spaces. These variables may be referred back to with underscores.

Referencing a variable

Given a YAML seed file:

---
group_labels:
  - _id: my_group_label #=> group_labels.my_group_label
    name: My Group Label
    color: "#FF0000"
  - _id: my_other_group_label #=> group_labels.my_other_group_label
    color: <%= group_labels.my_group_label.color %>

projects:
  - _id: my_project #=> projects.my_project
    name: My Project

When referring to a variable, the variable refers to the already seeded models. In other words, the model's id attribute will be populated.