How to use DeclarationState class of com.greghaskins.spectrum.internal package

Best Spectrum code snippet using com.greghaskins.spectrum.internal.DeclarationState

Source:Specification.java

...6import static com.greghaskins.spectrum.internal.hooks.BeforeHook.before;7import com.greghaskins.spectrum.Block;8import com.greghaskins.spectrum.ThrowingConsumer;9import com.greghaskins.spectrum.ThrowingSupplier;10import com.greghaskins.spectrum.internal.DeclarationState;11import com.greghaskins.spectrum.internal.Suite;12import com.greghaskins.spectrum.internal.blocks.IdempotentBlock;13import com.greghaskins.spectrum.internal.hooks.EagerLetHook;14import com.greghaskins.spectrum.internal.hooks.Hook;15import com.greghaskins.spectrum.internal.hooks.HookContext.AppliesTo;16import com.greghaskins.spectrum.internal.hooks.HookContext.Precedence;17import com.greghaskins.spectrum.internal.hooks.LetHook;18import org.junit.AssumptionViolatedException;19import java.util.function.Supplier;20public interface Specification {21  /**22   * Declare a test suite that describes the expected behavior of the system in a given context.23   *24   * @param context Description of the context for this suite25   * @param block   {@link Block} with one or more calls to {@link #it(String, Block) it} that26   *                define each expected behavior27   */28  static void describe(final String context, final Block block) {29    final Suite suite = DeclarationState.instance()30        .getCurrentSuiteBeingDeclared()31        .addSuite(context);32    suite.applyConfigurationFromBlock(block);33    DeclarationState.instance().beginDeclaration(suite, block);34  }35  /**36   * Focus on this specific suite, while ignoring others.37   *38   * @param context Description of the context for this suite39   * @param block   {@link Block} with one or more calls to {@link #it(String, Block) it} that40   *                define each expected behavior41   * @see #describe(String, Block)42   */43  static void fdescribe(final String context, final Block block) {44    describe(context, with(focus(), block));45  }46  /**47   * Ignore the specific suite.48   *49   * @param context Description of the context for this suite50   * @param block   {@link Block} with one or more calls to {@link #it(String, Block) it} that51   *                define each expected behavior52   * @see #describe(String, Block)53   */54  static void xdescribe(final String context, final Block block) {55    describe(context, with(ignore(), block));56  }57  /**58   * Declare a spec, or test, for an expected behavior of the system in this suite context.59   *60   * @param behavior Description of the expected behavior61   * @param block    {@link Block} that verifies the system behaves as expected and throws a {@link62   *                 java.lang.Throwable Throwable} if that expectation is not met.63   */64  static void it(final String behavior, final Block block) {65    DeclarationState.instance().getCurrentSuiteBeingDeclared().addSpec(behavior, block);66  }67  /**68   * Declare a pending spec (without a block) that will be ignored.69   *70   * @param behavior Description of the expected behavior71   * @see #xit(String, Block)72   */73  static void it(final String behavior) {74    DeclarationState.instance().getCurrentSuiteBeingDeclared().addSpec(behavior, null).ignore();75  }76  /**77   * Focus on this specific spec, while ignoring others.78   *79   * @param behavior Description of the expected behavior80   * @param block    {@link Block} that verifies the system behaves as expected and throws a {@link81   *                 java.lang.Throwable Throwable} if that expectation is not met.82   * @see #it(String, Block)83   */84  static void fit(final String behavior, final Block block) {85    it(behavior, with(focus(), block));86  }87  /**88   * Mark a spec as ignored so that it will be skipped.89   *90   * @param behavior Description of the expected behavior91   * @param block    {@link Block} that will not run, since this spec is ignored.92   * @see #it(String, Block)93   */94  static void xit(final String behavior, final Block block) {95    it(behavior);96  }97  /**98   * Declare a {@link Block} to be run before each spec in the suite.99   *100   * <p>101   * Use this to perform setup actions that are common across tests in the context. If multiple102   * {@code beforeEach} blocks are declared, they will run in declaration order.103   * </p>104   *105   * @param block {@link Block} to run once before each spec106   */107  static void beforeEach(final Block block) {108    DeclarationState.instance().addHook(before(block), AppliesTo.ATOMIC_ONLY, Precedence.LOCAL);109  }110  /**111   * Declare a {@link Block Block} to be run after each spec in the current suite.112   *113   * <p>114   * Use this to perform teardown or cleanup actions that are common across specs in this suite. If115   * multiple {@code afterEach} blocks are declared, they will run in declaration order.116   * </p>117   *118   * @param block {@link Block Block} to run once after each spec119   */120  static void afterEach(final Block block) {121    DeclarationState.instance().addHook(after(block), AppliesTo.ATOMIC_ONLY,122        Precedence.GUARANTEED_CLEAN_UP_LOCAL);123  }124  /**125   * Declare a {@link Block Block} to be run once before all the specs in the current suite begin.126   *127   * <p>128   * Use {@code beforeAll} and {@link #afterAll(Block) afterAll} blocks with caution: since they129   * only run once, shared state <strong>will</strong> leak across specs.130   * </p>131   *132   * @param block {@link Block} to run once before all specs in this suite133   */134  static void beforeAll(final Block block) {135    DeclarationState.instance().addHook(before(new IdempotentBlock(block)), AppliesTo.ATOMIC_ONLY,136        Precedence.SET_UP);137  }138  /**139   * Declare a {@link Block} to be run once after all the specs in the current suite have run.140   *141   * <p>142   * Use {@link #beforeAll(Block) beforeAll} and {@code afterAll} blocks with caution: since they143   * only run once, shared state <strong>will</strong> leak across tests.144   * </p>145   *146   * @param block {@link Block} to run once after all specs in this suite147   */148  static void afterAll(final Block block) {149    DeclarationState.instance().addHook(after(block), AppliesTo.ONCE,150        Precedence.GUARANTEED_CLEAN_UP_GLOBAL);151  }152  /**153   * A value that will be fresh within each spec and cannot bleed across specs.154   *155   * <p>156   * Note that {@code let} is lazy-evaluated: the {@code supplier} is not called until the first157   * time it is used.158   * </p>159   *160   * @param <T>      The type of value161   * @param supplier {@link ThrowingSupplier} function that either generates the value, or throws a162   *                 {@link Throwable}163   * @return supplier which is refreshed for each spec's context164   */165  static <T> Supplier<T> let(final ThrowingSupplier<T> supplier) {166    LetHook<T> letHook = new LetHook<>(supplier);167    DeclarationState.instance().addHook(letHook, AppliesTo.ATOMIC_ONLY, Precedence.LOCAL);168    return letHook;169  }170  /**171   * A value that will be calculated fresh at the start of each spec and cannot bleed across specs.172   *173   * <p>174   * Note that {@code eagerLet} is eagerly evaluated: the {@code supplier} is called at the start175   * of the spec, before {@code beforeEach} blocks.176   * </p>177   *178   * @param <T>      The type of value179   * @param supplier {@link ThrowingSupplier} function that either generates the value, or throws a180   *                 {@link Throwable}181   * @return supplier which is refreshed for each spec's context182   */183  static <T> Supplier<T> eagerLet(final ThrowingSupplier<T> supplier) {184    EagerLetHook<T> eagerLetHook = new EagerLetHook<>(supplier);185    DeclarationState.instance().addHook(eagerLetHook, AppliesTo.ATOMIC_ONLY, Precedence.LOCAL);186    return eagerLetHook;187  }188  /**189   * Define a test context. Alias for {@link #describe}.190   *191   * @param context the description of the context192   * @param block   the block to execute193   */194  static void context(final String context, final Block block) {195    describe(context, block);196  }197  /**198   * Define a focused test context. Alias for {@link #fdescribe}.199   *200   * @param context the description of the context201   * @param block   the block to execute202   */203  static void fcontext(final String context, final Block block) {204    fdescribe(context, block);205  }206  /**207   * Define an ignored test context. Alias for {@link #xdescribe}.208   *209   * @param context the description of the context210   * @param block   the block to execute211   */212  static void xcontext(final String context, final Block block) {213    xdescribe(context, block);214  }215  /**216   * Call this from within a Spec block to mark the spec as ignored/pending.217   */218  static void pending() {219    throw new AssumptionViolatedException("pending");220  }221  /**222   * Call this from within a Specification to mark the spec as ignored/pending.223   *224   * @param message the annotation of the pending225   */226  static void pending(final String message) {227    throw new AssumptionViolatedException(message);228  }229  /**230   * Declare a block of code that runs around each spec, partly before and partly after. You must231   * call {@link com.greghaskins.spectrum.Block#run} inside this Consumer. This code is applied to232   * every spec in the current suite.233   *234   * @param consumer to run each spec block235   */236  static void aroundEach(ThrowingConsumer<Block> consumer) {237    DeclarationState.instance().addHook(Hook.from(consumer), AppliesTo.ATOMIC_ONLY,238        Precedence.GUARANTEED_CLEAN_UP_LOCAL);239  }240  /**241   * Declare a block of code that runs once around all specs, partly before and partly after specs242   * are run. You must call {@link Block#run} inside this Consumer. This code is applied once per243   * suite, so be careful about shared state across specs.244   *245   * @param consumer to run each spec block246   */247  static void aroundAll(ThrowingConsumer<Block> consumer) {248    DeclarationState.instance().addHook(Hook.from(consumer), AppliesTo.ONCE, Precedence.OUTER);249  }250}...

Source:Configure.java

1package com.greghaskins.spectrum;2import com.greghaskins.spectrum.internal.DeclarationState;3import com.greghaskins.spectrum.internal.configuration.BlockFocused;4import com.greghaskins.spectrum.internal.configuration.BlockIgnore;5import com.greghaskins.spectrum.internal.configuration.BlockTagging;6import com.greghaskins.spectrum.internal.configuration.BlockTimeout;7import com.greghaskins.spectrum.internal.configuration.ConfiguredBlock;8import com.greghaskins.spectrum.internal.configuration.ExcludeTags;9import com.greghaskins.spectrum.internal.configuration.IncludeTags;10import com.greghaskins.spectrum.internal.junit.Rules;11import java.time.Duration;12import java.util.concurrent.TimeUnit;13import java.util.function.Supplier;14public interface Configure {15  String EXCLUDE_TAGS_PROPERTY = "spectrum.exclude.tags";16  String INCLUDE_TAGS_PROPERTY = "spectrum.include.tags";17  /**18   * Surround a {@link Block} with the {@code with} statement to add19   * configuration and metadata to it. E.g. <code>with(tags("foo"), () -&gt; {})</code>.<br>20   * Note: configuration metadata can be chained using the21   * {@link BlockConfigurationChain#and(BlockConfigurationChain)} method. E.g.22   * <code>with(tags("foo").and(ignore()), () -&gt; {})</code>23   *24   * @param configuration the chainable block configuration25   * @param block the enclosed block26   * @return a wrapped block with the given configuration27   * @see #ignore(String)28   * @see #ignore()29   * @see #focus()30   * @see #tags(String...)31   * @see #timeout(Duration)32   */33  static Block with(final BlockConfigurationChain configuration, final Block block) {34    return ConfiguredBlock.with(configuration.getBlockConfiguration(), block);35  }36  /**37   * Mark a block as ignored by surrounding it with the ignore method.38   *39   * @param why explanation of why this block is being ignored40   * @param block the block to ignore41   * @return a wrapped block which will be ignored42   */43  static Block ignore(final String why, final Block block) {44    return with(ignore(why), block);45  }46  /**47   * Mark a block as ignored by surrounding it with the ignore method.48   *49   * @param block the block to ignore50   * @return a wrapped block which will be ignored51   */52  static Block ignore(final Block block) {53    return with(ignore(), block);54  }55  /**56   * Ignore the suite or spec.57   *58   * @return a chainable configuration that will ignore the block within a {@link #with}59   */60  static BlockConfigurationChain ignore() {61    return new BlockConfigurationChain().with(new BlockIgnore());62  }63  /**64   * Ignore the suite or spec.65   *66   * @param reason why this block is ignored67   * @return a chainable configuration that will ignore the block within a {@link #with}68   */69  static BlockConfigurationChain ignore(final String reason) {70    return new BlockConfigurationChain().with(new BlockIgnore(reason));71  }72  /**73   * Tags the suite or spec that is being declared with the given strings. Depending on the current74   * filter criteria, this may lead to the item being ignored during test execution.75   *76   * @param tags tags that relate to the suite or spec77   * @return a chainable configuration that has these tags set for the block in {@link #with}78   */79  static BlockConfigurationChain tags(final String... tags) {80    return new BlockConfigurationChain().with(new BlockTagging(tags));81  }82  /**83   * Marks the suite or spec to be focused.84   *85   * @return a chainable configuration that will focus the suite or spec in the {@link #with}86   */87  static BlockConfigurationChain focus() {88    return new BlockConfigurationChain().with(new BlockFocused());89  }90  /**91   * Apply timeout to all leaf nodes from this level down. Can be superseded by a lower level having its92   * own timeout.93   * @param timeout the amount of the timeout94   * @return a chainable configuration that will apply a timeout to all leaf nodes below95   */96  static BlockConfigurationChain timeout(Duration timeout) {97    return new BlockConfigurationChain().with(new BlockTimeout(timeout));98  }99  /**100   * Filter which tests in the current suite will run.101   *102   * <br><br>103   * {@code filterRun(includeTags("foo").and(excludeTags("bar")));}104   *105   * @param configuration chainable filter configuration106   * @see #includeTags(String...)107   * @see #excludeTags(String...)108   */109  static void filterRun(FilterConfigurationChain configuration) {110    configuration.applyTo(DeclarationState.instance().getCurrentSuiteBeingDeclared());111  }112  /**113   * Set the test filter to require at least one of these tags for all following specs.114   *115   * @param tagsToInclude specs (or their parent suite) must have at least one of these116   * @return FilterConfigurationChain instance for chaining further calls117   */118  static FilterConfigurationChain includeTags(String... tagsToInclude) {119    return new FilterConfigurationChain(new IncludeTags(tagsToInclude));120  }121  /**122   * Set the test filter to exclude any following specs that have one of these tags.123   *124   * @param tagsToExclude specs and their parent suite must not have any of these125   * @return FilterConfigurationChain instance for chaining further calls126   */127  static FilterConfigurationChain excludeTags(String... tagsToExclude) {128    return new FilterConfigurationChain(new ExcludeTags(tagsToExclude));129  }130  /**131   * Uses the given class as a mix-in for JUnit rules to be applied. These rules will cascade down132   * and be applied at the level of specs or atomic specs.133   *134   * @param classWithRules Class to create and apply rules to for each spec.135   * @param <T>            type of the object136   * @return a supplier of the rules object137   */138  static <T> Supplier<T> junitMixin(final Class<T> classWithRules) {139    return Rules.applyRules(classWithRules, DeclarationState.instance()::addHook);140  }141}...

Source:DeclarationState.java

...5import com.greghaskins.spectrum.internal.hooks.HookContext.AppliesTo;6import com.greghaskins.spectrum.internal.hooks.HookContext.Precedence;7import java.util.ArrayDeque;8import java.util.Deque;9public final class DeclarationState {10  private static final ThreadLocal<DeclarationState> instance =11      ThreadLocal.withInitial(DeclarationState::new);12  public static DeclarationState instance() {13    return instance.get();14  }15  private final Deque<Suite> suiteStack = new ArrayDeque<>();16  private DeclarationState() {}17  public Suite getCurrentSuiteBeingDeclared() {18    return suiteStack.peek();19  }20  private int getCurrentDepth() {21    return suiteStack.size();22  }23  public void beginDeclaration(final Suite suite, final Block definitionBlock) {24    suiteStack.push(suite);25    try {26      definitionBlock.run();27    } catch (final Throwable error) {28      suite.removeAllChildren();29      suite.addSpec("encountered an error", () -> {30        throw error;...

DeclarationState

Using AI Code Generation

1package com.greghaskins.spectrum;2import com.greghaskins.spectrum.internal.DeclarationState;3public class 1 {4    public static void main(String[] args) {5        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());6    }7}8package com.greghaskins.spectrum;9import com.greghaskins.spectrum.internal.DeclarationState;10public class 2 {11    public static void main(String[] args) {12        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());13    }14}15package com.greghaskins.spectrum;16import com.greghaskins.spectrum.internal.DeclarationState;17public class 3 {18    public static void main(String[] args) {19        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());20    }21}22package com.greghaskins.spectrum;23import com.greghaskins.spectrum.internal.DeclarationState;24public class 4 {25    public static void main(String[] args) {26        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());27    }28}29package com.greghaskins.spectrum;30import com.greghaskins.spectrum.internal.DeclarationState;31public class 5 {32    public static void main(String[] args) {33        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());34    }35}36package com.greghaskins.spectrum;37import com.greghaskins.spectrum.internal.DeclarationState;38public class 6 {39    public static void main(String[] args) {40        System.out.println(DeclarationState.getDeclarationState().isInDeclarationPhase());41    }42}

DeclarationState

Using AI Code Generation

1package com.greghaskins.spectrum;2import com.greghaskins.spectrum.internal.DeclarationState;3import org.junit.Test;4import static org.junit.Assert.*;5public class TestSpectrum {6    public void test() {7        DeclarationState state = new DeclarationState();8        assertEquals(0, state.getDepth());9        state.incrementDepth();10        assertEquals(1, state.getDepth());11        state.decrementDepth();12        assertEquals(0, state.getDepth());13    }14}

DeclarationState

Using AI Code Generation

1import com.greghaskins.spectrum.internal.DeclarationState;2public class 1 {3    public static void main(String[] args) {4        DeclarationState state = DeclarationState.getCurrentState();5        System.out.println(state.getTestName());6    }7}

DeclarationState

Using AI Code Generation

1public class 1 {2    public static void main(String[] args) {3        DeclarationState ds = new DeclarationState();4        ds.setDeclared(true);5        System.out.println(ds.isDeclared());6    }7}

DeclarationState

Using AI Code Generation

1import com.greghaskins.spectrum.internal.DeclarationState;2import org.junit.Test;3public class 1 {4    public void test() {5        DeclarationState.set(DeclarationState.DECLARING);6    }7}8To use the internal package, add the following import to your test class:9import com.greghaskins.spectrum.internal.DeclarationState;10DeclarationState.set(DeclarationState.DECLARING);11import com.greghaskins.spectrum.internal.DeclarationState;12import org.junit.Test;13public class 1 {14    public void test() {15        DeclarationState.set(DeclarationState.DECLARING);16    }17}18To use the internal package, add the following import to your test class:19import com.greghaskins.spectrum.internal.DeclarationState;20DeclarationState.set(DeclarationState.DECLARING);

DeclarationState

Using AI Code Generation

1import com.greghaskins.spectrum.Spectrum;2import com.greghaskins.spectrum.internal.DeclarationState;3import static com.greghaskins.spectrum.Spectrum.*;4import org.junit.runner.JUnitCore;5public class 1 {6    public static void main(String[] args) {7        JUnitCore.runClasses(Spectrum.class);8        System.out.println(DeclarationState.getCurrentState());9    }10}11import com.greghaskins.spectrum.Spectrum;12import com.greghaskins.spectrum.internal.DeclarationState;13import static com.greghaskins.spectrum.Spectrum.*;14import org.junit.runner.JUnitCore;15public class 2 {16    public static void main(String[] args) {17        JUnitCore.runClasses(Spectrum.class);18        System.out.println(DeclarationState.getCurrentState());19    }20}21import com.greghaskins.spectrum.Spectrum;22import com.greghaskins.spectrum.internal.DeclarationState;23import static com.greghaskins.spectrum.Spectrum.*;24import org.junit.runner.JUnitCore;25public class 3 {26    public static void main(String[] args) {27        JUnitCore.runClasses(Spectrum.class);28        System.out.println(DeclarationState.getCurrentState());29    }30}31import com.greghaskins.spectrum.Spectrum;32import com.greghaskins.spectrum

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.