ores.cpp.generator.generator_impl

Table of Contents

faker-cxx generation per column type. generator profile. Uses faker-cxx to produce structurally-valid synthetic instances. Counter-suffixed keys guarantee uniqueness within a test run; temporal fields are filled with plausible past timestamps via the generation context.

See the Template variable reference for the complete list of available variables and their semantics.

Template

The full template source. Edit here and re-tangle with compass build --direct tangle_codegen_templates to regenerate library/templates/cpp_domain_type_generator.cpp.mustache.

{{! GENERATED FILE — tangled from projects/ores.codegen/library/templates/cpp_domain.org. Edit the org source. }}
{{{cpp_license}}}
{{#domain_entity}}
#include "ores.{{component_include}}/{{generator_facet_name}}/{{entity_singular}}_generator.hpp"

#include <atomic>
#include <string>
#include <unordered_set>
#include <faker-cxx/faker.h> // IWYU pragma: keep.
{{#has_tenant_id}}
#include "ores.utility/uuid/tenant_id.hpp"
{{/has_tenant_id}}
#include "ores.utility/generation/generation_keys.hpp"

namespace ores::{{component}}::{{generator_facet_name}} {

using ores::utility::generation::generation_keys;

domain::{{entity_singular}} generate_synthetic_{{entity_singular}}(
    utility::generation::generation_context& ctx) {
{{#needs_counter}}
    static std::atomic<int> counter{0};
{{/needs_counter}}
{{#has_audit_columns}}
    const auto modified_by = ctx.env().get_or(
        std::string(generation_keys::modified_by), "system");
{{/has_audit_columns}}
{{#has_tenant_id}}
    const auto tid_str = ctx.env().get_or(
        std::string(generation_keys::tenant_id), std::string("system"));
{{/has_tenant_id}}

    domain::{{entity_singular}} r;
{{#has_audit_columns}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}version = 0;
{{/has_audit_columns}}
{{#has_tenant_id}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}tenant_id = utility::uuid::tenant_id::from_string(tid_str)
        .value_or(utility::uuid::tenant_id::system());
{{/has_tenant_id}}
{{#has_workspace_id}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}workspace_id = utility::uuid::live_workspace_id();
{{/has_workspace_id}}
{{#primary_key.is_text}}
    const auto idx = counter.fetch_add(1, std::memory_order_relaxed);
{{#primary_key.generator_expr}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}{{primary_key.column}} = {{{primary_key.generator_expr}}} + "-"
        + std::to_string(idx);
{{/primary_key.generator_expr}}
{{^primary_key.generator_expr}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}{{primary_key.column}} = std::string(faker::word::noun()) + "-"
        + std::to_string(idx);
{{/primary_key.generator_expr}}
{{/primary_key.is_text}}
{{#primary_key.is_uuid}}
    r.{{#has_identity_group}}identity.{{/has_identity_group}}{{primary_key.column}} = ctx.generate_uuid();
{{#has_text_natural_keys}}
    const auto idx = counter.fetch_add(1, std::memory_order_relaxed);
{{/has_text_natural_keys}}
{{/primary_key.is_uuid}}
{{#primary_key.extra_columns}}
{{#is_uuid}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{column}} = ctx.generate_uuid();
{{/is_uuid}}
{{^is_uuid}}
{{#generator_expr}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{column}} = {{{generator_expr}}};
{{/generator_expr}}
{{^generator_expr}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{column}} = std::string(faker::word::noun());
{{/generator_expr}}
{{/is_uuid}}
{{/primary_key.extra_columns}}
{{#natural_keys}}
{{#is_uuid}}
    r.{{column}} = ctx.generate_uuid();
{{/is_uuid}}
{{#is_int}}
{{#generator_expr}}
    r.{{column}} = {{{generator_expr}}};
{{/generator_expr}}
{{^generator_expr}}
    r.{{column}} = 0;
{{/generator_expr}}
{{/is_int}}
{{#is_timestamp}}
{{#generator_expr}}
    r.{{column}} = {{{generator_expr}}};
{{/generator_expr}}
{{^generator_expr}}
    r.{{column}} = ctx.past_timepoint();
{{/generator_expr}}
{{/is_timestamp}}
{{#is_date}}
{{#generator_expr}}
    r.{{column}} = {{{generator_expr}}};
{{/generator_expr}}
{{^generator_expr}}
    r.{{column}} = std::chrono::year_month_day{
        std::chrono::floor<std::chrono::days>(ctx.past_timepoint())};
{{/generator_expr}}
{{/is_date}}
{{^is_uuid}}
{{^is_int}}
{{^is_timestamp}}
{{^is_date}}
{{#generator_expr}}
{{#no_generator_suffix}}
    r.{{column}} = {{{generator_expr}}};
{{/no_generator_suffix}}
{{^no_generator_suffix}}
    r.{{column}} = {{{generator_expr}}} + "-"
        + std::to_string(idx);
{{/no_generator_suffix}}
{{/generator_expr}}
{{^generator_expr}}
    r.{{column}} = std::string(faker::word::noun()) + "-"
        + std::to_string(idx);
{{/generator_expr}}
{{/is_date}}
{{/is_timestamp}}
{{/is_int}}
{{/is_uuid}}
{{/natural_keys}}
{{#columns}}
{{#generator_expr}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{name}} = {{{generator_expr}}};
{{/generator_expr}}
{{^generator_expr}}
{{#is_uuid}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{name}} = ctx.generate_uuid();
{{/is_uuid}}
{{#is_plain_string}}
    r.{{#is_identity_group_column}}identity.{{/is_identity_group_column}}{{name}} = std::string(faker::word::noun());
{{/is_plain_string}}
{{/generator_expr}}
{{/columns}}
{{#has_audit_columns}}
    r.{{#has_audit_group}}audit.{{/has_audit_group}}modified_by = modified_by;
    r.{{#has_audit_group}}audit.{{/has_audit_group}}performed_by = modified_by;
    r.{{#has_audit_group}}audit.{{/has_audit_group}}change_reason_code = "system.test";
    r.{{#has_audit_group}}audit.{{/has_audit_group}}change_commentary = "Synthetic test data";
{{/has_audit_columns}}
    r.{{#has_audit_group}}audit.{{/has_audit_group}}recorded_at = ctx.past_timepoint();
    return r;
}

std::vector<domain::{{entity_singular}}>
generate_synthetic_{{entity_plural}}(std::size_t n,
    utility::generation::generation_context& ctx) {
    std::vector<domain::{{entity_singular}}> r;
    r.reserve(n);
    while (r.size() < n)
        r.push_back(generate_synthetic_{{entity_singular}}(ctx));
    return r;
}

<<paste:C2F8A4E3-7D5B-4C2F-8A1E-3D9C6B2E5F1A>>
}
{{/domain_entity}}
{{#junction}}
#include "ores.{{component_include}}/{{generator_facet_name}}/{{name_singular}}_generator.hpp"

{{#has_uuid_left_or_right}}
#include <boost/uuid/uuid_io.hpp>
{{/has_uuid_left_or_right}}
{{#needs_counter}}
#include <atomic>
{{/needs_counter}}
#include <faker-cxx/faker.h> // IWYU pragma: keep.
#include "ores.utility/generation/generation_keys.hpp"

namespace ores::{{component}}::{{generator_facet_name}} {

using ores::utility::generation::generation_keys;

domain::{{name_singular}} generate_synthetic_{{name_singular}}(
    utility::generation::generation_context& ctx) {
{{#needs_counter}}
    static std::atomic<int> counter{0};
    const auto idx = counter.fetch_add(1, std::memory_order_relaxed);
{{/needs_counter}}
    const auto modified_by = ctx.env().get_or(
        generation_keys::modified_by, "system");
{{#has_tenant_id}}
    const auto tenant_id = ctx.env().get_or(
        generation_keys::tenant_id, "system");
{{/has_tenant_id}}

    domain::{{name_singular}} r;
    r.version = 0;
{{#has_tenant_id}}
    r.tenant_id = tenant_id;
{{/has_tenant_id}}
    r.{{left.column}} = {{{left.generator_expr}}};
    r.{{right.column}} = {{{right.generator_expr}}};
{{#columns}}
    r.{{name}} = {{{generator_expr}}};
{{/columns}}
    r.modified_by = modified_by;
    r.performed_by = modified_by;
    r.change_reason_code = "system.test";
    r.change_commentary = "Synthetic test data";
    r.recorded_at = ctx.past_timepoint();
    return r;
}

std::vector<domain::{{name_singular}}>
generate_synthetic_{{name}}(std::size_t n,
    utility::generation::generation_context& ctx) {
    std::vector<domain::{{name_singular}}> r;
    r.reserve(n);
    while (r.size() < n)
        r.push_back(generate_synthetic_{{name_singular}}(ctx));
    return r;
}

}
{{/junction}}

See also

Emacs 29.3 (Org mode 9.6.15)