All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.neo4j.internal.schema.RandomSchemaBase Maven / Gradle / Ivy

There is a newer version: 5.24.0
Show newest version
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.internal.schema;

import java.util.Arrays;
import java.util.SplittableRandom;
import java.util.function.Supplier;
import java.util.stream.Stream;
import org.neo4j.common.EntityType;
import org.neo4j.internal.schema.constraints.ConstraintDescriptorFactory;
import org.neo4j.internal.schema.constraints.IndexBackedConstraintDescriptor;
import org.neo4j.internal.schema.constraints.PropertyTypeSet;
import org.neo4j.internal.schema.constraints.SchemaValueType;
import org.neo4j.values.storable.RandomValues;
import org.neo4j.values.storable.TextValue;
import org.neo4j.values.storable.ValueGroup;
import org.neo4j.values.storable.ValueType;

@SuppressWarnings("WeakerAccess") // Keep accessibility high in case someone wants to extend this class in the future.
public abstract class RandomSchemaBase implements Supplier {
    private final SplittableRandom rng;
    private final int maxPropKeyId;
    private final int maxRelTypeId;
    private final int maxLabelId;
    private final int defaultLabelIdsArrayMaxLength;
    private final int defaultRelationshipTypeIdsArrayMaxLength;
    private final int defaultPropertyKeyIdsArrayMaxLength;
    private final RandomValues values;
    private final ValueType[] textTypes;

    public RandomSchemaBase() {
        this(new SplittableRandom());
    }

    public RandomSchemaBase(SplittableRandom rng) {
        this.rng = rng;
        maxPropKeyId = maxPropertyKeyId();
        maxRelTypeId = maxRelationshipTypeId();
        maxLabelId = maxLabelId();
        defaultLabelIdsArrayMaxLength = defaultLabelIdsArrayMaxLength();
        defaultRelationshipTypeIdsArrayMaxLength = defaultRelationshipTypeIdsArrayMaxLength();
        defaultPropertyKeyIdsArrayMaxLength = defaultPropertyKeyIdsArrayMaxLength();
        values = RandomValues.create(rng, valuesConfiguration());
        textTypes = RandomValues.typesOfGroup(ValueGroup.TEXT);
    }

    protected abstract int maxPropertyKeyId();

    protected abstract int maxRelationshipTypeId();

    protected abstract int maxLabelId();

    protected int defaultLabelIdsArrayMaxLength() {
        return 200;
    }

    protected int defaultRelationshipTypeIdsArrayMaxLength() {
        return 200;
    }

    protected int defaultPropertyKeyIdsArrayMaxLength() {
        return 300;
    }

    protected RandomValues.Default valuesConfiguration() {
        return new RandomValues.Default() {
            @Override
            public int stringMaxLength() {
                return 200;
            }

            @Override
            public int minCodePoint() {
                return super.minCodePoint() + 1; // Avoid null-bytes in our strings.
            }
        };
    }

    public Stream schemaRules() {
        return Stream.generate(this);
    }

    @Override
    public SchemaRule get() {
        return nextSchemaRule();
    }

    public SchemaRule nextSchemaRule() {
        if (rng.nextBoolean()) {
            return nextIndex();
        } else {
            return nextConstraint();
        }
    }

    public IndexDescriptor nextIndex() {
        int choice = rng.nextInt(4);
        SchemaDescriptor schema =
                switch (choice) {
                    case 0 -> nextNodeSchema();
                    case 1 -> nextNodeFulltextSchema();
                    case 2 -> nextRelationshipSchema();
                    case 3 -> nextRelationshipFulltextSchema();
                    default -> throw new RuntimeException("Bad index choice: " + choice);
                };

        boolean isUnique = rng.nextBoolean() && !schema.isSchemaDescriptorType(FulltextSchemaDescriptor.class);
        IndexPrototype prototype = isUnique ? IndexPrototype.uniqueForSchema(schema) : IndexPrototype.forSchema(schema);

        IndexProviderDescriptor providerDescriptor = new IndexProviderDescriptor(nextName(), nextName());
        prototype = prototype.withIndexProvider(providerDescriptor);

        prototype = prototype.withName(nextName());
        if (schema.isSchemaDescriptorType(FulltextSchemaDescriptor.class)) {
            prototype = prototype.withIndexType(IndexType.FULLTEXT);
        }

        long ruleId = nextRuleIdForIndex();
        IndexDescriptor index = prototype.materialise(ruleId);

        if (isUnique && rng.nextBoolean()) {
            index = index.withOwningConstraintId(existingConstraintId());
        }

        return index;
    }

    public long nextRuleIdForIndex() {
        return nextRuleId();
    }

    public long existingConstraintId() {
        return nextRuleId();
    }

    public ConstraintDescriptor nextConstraint() {
        long ruleId = nextRuleIdForConstraint();
        int choice = rng.nextInt(12);

        return switch (choice) {
            case 0 -> ConstraintDescriptorFactory.existsForSchema(nextRelationshipSchema(), false)
                    .withId(ruleId)
                    .withName(nextName());
            case 1 -> ConstraintDescriptorFactory.existsForSchema(nextNodeSchema(), false)
                    .withId(ruleId)
                    .withName(nextName());
            case 2 -> ConstraintDescriptorFactory.uniqueForSchema(nextNodeSchema())
                    .withId(ruleId)
                    .withName(nextName());
            case 3 -> ConstraintDescriptorFactory.uniqueForSchema(nextNodeSchema())
                    .withId(ruleId)
                    .withOwnedIndexId(existingIndexId())
                    .withName(nextName());
            case 4 -> ConstraintDescriptorFactory.keyForSchema(nextNodeSchema())
                    .withId(ruleId)
                    .withName(nextName());
            case 5 -> ConstraintDescriptorFactory.keyForSchema(nextNodeSchema())
                    .withId(ruleId)
                    .withOwnedIndexId(existingIndexId())
                    .withName(nextName());
            case 6 -> ConstraintDescriptorFactory.keyForSchema(nextRelationshipSchema())
                    .withId(ruleId)
                    .withName(nextName());
            case 7 -> ConstraintDescriptorFactory.keyForSchema(nextRelationshipSchema())
                    .withId(ruleId)
                    .withOwnedIndexId(existingIndexId())
                    .withName(nextName());
            case 8 -> ConstraintDescriptorFactory.uniqueForSchema(nextRelationshipSchema())
                    .withId(ruleId)
                    .withName(nextName());
            case 9 -> ConstraintDescriptorFactory.uniqueForSchema(nextRelationshipSchema())
                    .withId(ruleId)
                    .withOwnedIndexId(existingIndexId())
                    .withName(nextName());
            case 10 -> ConstraintDescriptorFactory.typeForSchema(nextRelationshipSchema(), randomAllowedTypes(), false)
                    .withId(ruleId)
                    .withName(nextName());
            case 11 -> ConstraintDescriptorFactory.typeForSchema(nextNodeSchema(), randomAllowedTypes(), false)
                    .withId(ruleId)
                    .withName(nextName());
            default -> throw new RuntimeException("Bad constraint choice: " + choice);
        };
    }

    private PropertyTypeSet randomAllowedTypes() {
        return PropertyTypeSet.of(RandomValues.create(rng).selection(SchemaValueType.values(), 1, 5, false));
    }

    public long nextRuleIdForConstraint() {
        return nextRuleId();
    }

    public long existingIndexId() {
        return nextRuleId();
    }

    public LabelSchemaDescriptor nextNodeSchema() {
        return SchemaDescriptors.forLabel(nextLabelId(), nextPropertyKeyIdsArray());
    }

    public RelationTypeSchemaDescriptor nextRelationshipSchema() {
        return SchemaDescriptors.forRelType(nextRelationshipTypeId(), nextPropertyKeyIdsArray());
    }

    public SchemaDescriptor nextNodeFulltextSchema() {
        return SchemaDescriptors.fulltext(EntityType.NODE, nextLabelIdsArray(), nextPropertyKeyIdsArray());
    }

    public SchemaDescriptor nextRelationshipFulltextSchema() {
        return SchemaDescriptors.fulltext(
                EntityType.RELATIONSHIP, nextRelationTypeIdsArray(), nextPropertyKeyIdsArray());
    }

    public int nextRuleId() {
        return rng.nextInt(Integer.MAX_VALUE);
    }

    public String nextName() {
        String name;
        do {
            name = ((TextValue) values.nextValueOfTypes(textTypes))
                    .stringValue()
                    .trim();
        } while (name.isEmpty()
                || name.isBlank()
                || name.contains("\0")
                || name.contains("`")); // Avoid generating empty names.
        return name;
    }

    public int nextLabelId() {
        return rng.nextInt(maxLabelId);
    }

    public int nextRelationshipTypeId() {
        return rng.nextInt(maxRelTypeId);
    }

    public int[] nextLabelIdsArray() {
        return nextLabelIdsArray(defaultLabelIdsArrayMaxLength);
    }

    public int[] nextLabelIdsArray(int maxLength) {
        return rng.ints(rng.nextInt(1, maxLength), 1, maxLabelId).toArray();
    }

    public int[] nextRelationTypeIdsArray() {
        return nextRelationTypeIdsArray(defaultRelationshipTypeIdsArrayMaxLength);
    }

    public int[] nextRelationTypeIdsArray(int maxLength) {
        return rng.ints(rng.nextInt(1, maxLength), 1, maxRelTypeId).toArray();
    }

    public int[] nextPropertyKeyIdsArray() {
        return nextPropertyKeyIdsArray(defaultPropertyKeyIdsArrayMaxLength);
    }

    public int[] nextPropertyKeyIdsArray(int maxLength) {
        int propCount = rng.nextInt(1, maxLength + 1);
        return rng.ints(propCount, 1, maxPropKeyId).toArray();
    }

    public static boolean schemaDeepEquals(SchemaRule a, SchemaRule b) {
        if (!a.equals(b)) {
            return false;
        }
        if (a.getId() != b.getId()) {
            return false;
        }
        if (!a.getName().equals(b.getName())) {
            return false;
        }
        if (a.getClass() != b.getClass()) {
            return false;
        }
        if (a instanceof IndexDescriptor indexA && b instanceof IndexDescriptor indexB) {
            return indexA.getCapability().equals(indexB.getCapability())
                    && indexA.isUnique() == indexB.isUnique()
                    && indexA.getIndexProvider().equals(indexB.getIndexProvider())
                    && indexA.getIndexType() == indexB.getIndexType()
                    && indexA.getOwningConstraintId().equals(indexB.getOwningConstraintId())
                    && schemaDeepEquals(indexA.schema(), indexB.schema());
        } else if (a instanceof ConstraintDescriptor constraintA && b instanceof ConstraintDescriptor constraintB) {
            if (constraintA.isIndexBackedConstraint() && constraintB.isIndexBackedConstraint()) {
                IndexBackedConstraintDescriptor ibcA = constraintA.asIndexBackedConstraint();
                IndexBackedConstraintDescriptor ibcB = constraintB.asIndexBackedConstraint();
                return ibcA.hasOwnedIndexId() == ibcB.hasOwnedIndexId()
                        && (!ibcA.hasOwnedIndexId() || ibcA.ownedIndexId() == ibcB.ownedIndexId())
                        && ibcA.equals(ibcB)
                        && schemaDeepEquals(ibcA.schema(), ibcB.schema());
            } else {
                return constraintA.isIndexBackedConstraint() == constraintB.isIndexBackedConstraint()
                        && constraintA.equals(constraintB)
                        && schemaDeepEquals(constraintA.schema(), constraintB.schema());
            }
        } else {
            throw new IllegalArgumentException("Unsupported type of a:" + a + " and b:" + b);
        }
    }

    public static boolean schemaDeepEquals(SchemaDescriptor a, SchemaDescriptor b) {
        return a.entityType() == b.entityType()
                && a.schemaPatternMatchingType() == b.schemaPatternMatchingType()
                && Arrays.equals(a.getEntityTokenIds(), b.getEntityTokenIds())
                && Arrays.equals(a.getPropertyIds(), b.getPropertyIds());
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy