Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…nal-testing into main
  • Loading branch information
Jason Holt Smith committed May 15, 2024
2 parents a6a70f0 + b91ef5d commit f4e2963
Show file tree
Hide file tree
Showing 233 changed files with 4,200 additions and 5,897 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ describe('Sample Test', () => {
```
the above results in the following console output if the expectation does not return false or throw an exception:
```
5:29:55 PM - [[C1234] can perform a demonstration of AFT] - PASS - C1234
5:29:55 PM - [Sample Test [C1234] can perform a demonstration of AFT] - PASS - C1234
```
in more complex scenarios you can perform multiple actions inside the _expectation_ like in the following example:
```typescript
Expand Down Expand Up @@ -60,12 +60,12 @@ describe('Sample Test', () => {
```
which would output the following logs:
```
5:29:54 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - STEP - 1: creating instance of FeatureObj
5:29:55 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - PASS - C2345
5:29:55 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - STEP - 2: about to call performAction
5:29:55 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - INFO - result of performAction was 'result of action'
5:29:56 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - TRACE - successfully executed expectation
5:29:56 PM - [[C2345][C3344] can perform a more complex demonstration of AFT] - PASS - C3344
5:29:54 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - STEP - 1: creating instance of FeatureObj
5:29:55 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - PASS - C2345
5:29:55 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - STEP - 2: about to call performAction
5:29:55 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - INFO - result of performAction was 'result of action'
5:29:56 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - TRACE - successfully executed expectation
5:29:56 PM - [Sample Test [C2345][C3344] can perform a more complex demonstration of AFT] - PASS - C3344
```

#### WARNING:
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

37 changes: 19 additions & 18 deletions docs/classes/aft_core_src.AftConfig.html

Large diffs are not rendered by default.

21 changes: 11 additions & 10 deletions docs/classes/aft_core_src.AftLogger.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AftLogger</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L26">packages/aft-core/src/logging/aft-logger.ts:26</a></li></ul></aside>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L26">packages/aft-core/src/logging/aft-logger.ts:26</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -75,14 +75,14 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">aftCfg</span>: <a href="aft_core_src.AftConfig.html" class="tsd-signature-type tsd-kind-class">AftConfig</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="aft_core_src.AftLogger.html" class="tsd-signature-type tsd-kind-class">AftLogger</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L34">packages/aft-core/src/logging/aft-logger.ts:34</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L34">packages/aft-core/src/logging/aft-logger.ts:34</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="aftCfg" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>aft<wbr/>Cfg</span><a href="#aftCfg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">aft<wbr/>Cfg</span><span class="tsd-signature-symbol">:</span> <a href="aft_core_src.AftConfig.html" class="tsd-signature-type tsd-kind-class">AftConfig</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L27">packages/aft-core/src/logging/aft-logger.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L27">packages/aft-core/src/logging/aft-logger.ts:27</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="loggerName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logger<wbr/>Name</span><a href="#loggerName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">logger<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
Expand All @@ -91,7 +91,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L32">packages/aft-core/src/logging/aft-logger.ts:32</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L32">packages/aft-core/src/logging/aft-logger.ts:32</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member"><a id="logLevel" class="tsd-anchor"></a>
Expand All @@ -117,21 +117,21 @@ <h3 class="tsd-anchor-link"><span>log<wbr/>Level</span><a href="#logLevel" aria-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;trace&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;debug&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;step&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;warn&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pass&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fail&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;error&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;none&quot;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L53">packages/aft-core/src/logging/aft-logger.ts:53</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L53">packages/aft-core/src/logging/aft-logger.ts:53</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="format" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>format</span><a href="#format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="format.format-1"><span class="tsd-kind-call-signature">format</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#format.format-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="format.format-1"><span class="tsd-kind-call-signature">format</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">logObj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#format.format-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>formats the passed in <code>LogMessage.message</code> based on the passed in options</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">data</span>: <a href="../types/aft_core_src.LogMessageData.html" class="tsd-signature-type tsd-kind-type-alias">LogMessageData</a></h5>
<h5><span class="tsd-kind-parameter">logObj</span>: <a href="../types/aft_core_src.LogMessageData.html" class="tsd-signature-type tsd-kind-type-alias">LogMessageData</a></h5>
<div class="tsd-comment tsd-typography"><p>a <code>LogMessage</code> object containing the <code>level</code>, <code>name</code> and <code>message</code> to
be formatted into a console-friendly log string</p>
</div>
Expand All @@ -140,7 +140,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L79">packages/aft-core/src/logging/aft-logger.ts:79</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L79">packages/aft-core/src/logging/aft-logger.ts:79</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="log" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>log</span><a href="#log" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -163,7 +163,7 @@ <h5><span class="tsd-kind-parameter">data</span>: <a href="../types/aft_core_src
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L65">packages/aft-core/src/logging/aft-logger.ts:65</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L65">packages/aft-core/src/logging/aft-logger.ts:65</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="toConsole" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>to<wbr/>Console</span><a href="#toConsole" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -193,7 +193,7 @@ <h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/a40b98f/packages/aft-core/src/logging/aft-logger.ts#L106">packages/aft-core/src/logging/aft-logger.ts:106</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/bicarbon8/automated-functional-testing/blob/fb4014c/packages/aft-core/src/logging/aft-logger.ts#L107">packages/aft-core/src/logging/aft-logger.ts:107</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -298,6 +298,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../functions/aft_core_src.havingProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>having<wbr/>Props</span></a></li>
<li><a href="../functions/aft_core_src.havingValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>having<wbr/>Value</span></a></li>
<li><a href="../functions/aft_core_src.lessThan.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>less<wbr/>Than</span></a></li>
<li><a href="../functions/aft_core_src.matchingProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>matching<wbr/>Props</span></a></li>
<li><a href="../functions/aft_core_src.not.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>not</span></a></li>
<li><a href="../functions/aft_core_src.retry-1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>retry</span></a></li>
<li><a href="../functions/aft_core_src.using.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>using</span></a></li></ul></div></details></li>
Expand Down
Loading

0 comments on commit f4e2963

Please sign in to comment.