Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions .github/workflows/blackbox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,6 @@ jobs:
--file=Makefile.workflow \
github:build:blackbox:module \
ansible-aws
- name: Build Blackbox "aws" module
run: |
make \
--file=Makefile.workflow \
github:build:blackbox:module \
aws
# - name: Build Blackbox "chef" module
# run: |
# make \
Expand Down Expand Up @@ -130,12 +124,6 @@ jobs:
--file=Makefile.workflow \
github:push:blackbox:module \
ansible-aws
- name: Push Blackbox "aws" module
run: |
make \
--file=Makefile.workflow \
github:push:blackbox:module \
aws
# - name: Push Blackbox "chef" module
# run: |
# make \
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
/.idea/

.vagrant/
9 changes: 0 additions & 9 deletions docs/module/aws/check/build.step.md

This file was deleted.

71 changes: 71 additions & 0 deletions docs/module/aws/check/evaluate/assert.evaluate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# module/aws/check/evaluate/assert.evaluate

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/assert.evaluate

## Overview

Step "evaluate" asserter

## Index

* [blackbox.module.aws.check.evaluate.assert.false](#blackboxmoduleawscheckevaluateassertfalse)
* [blackbox.module.aws.check.evaluate.assert.normalize](#blackboxmoduleawscheckevaluateassertnormalize)
* [blackbox.module.aws.check.evaluate.assert.true](#blackboxmoduleawscheckevaluateasserttrue)

## blackbox.module.aws.check.evaluate.assert.*

### blackbox.module.aws.check.evaluate.assert.false

#### Example

```bash
# Asserts the false expression "(false -eq true)" with missing "10" score and a specific message that has an argument
blackbox.module.aws.check.evaluate.assert.false "(false -eq true)" 10 "Assert message with argument '%s'" "argument"
```

#### Arguments

* **$1** (type=string): Assert expression
* **$2** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert message

#### Output on stdout

* Formatted assert

### blackbox.module.aws.check.evaluate.assert.normalize

#### Example

```bash
# Normalize assert expression
blackbox.module.aws.check.evaluate.assert.normalize "(true -eq true)"
```

#### Arguments

* **$1** (type=string): Assert expression

#### Output on stdout

* Normalized assert

### blackbox.module.aws.check.evaluate.assert.true

#### Example

```bash
# Asserts the true expression "(true -eq true)" with "10" score and a specific message that has an argument
blackbox.module.aws.check.evaluate.assert.true "(true -eq true)" 10 "Assert message with argument '%s'" "argument"
```

#### Arguments

* **$1** (type=string): Assert expression
* **$2** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert message

#### Output on stdout

* Formatted assert

9 changes: 9 additions & 0 deletions docs/module/aws/check/evaluate/expect.evaluate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# module/aws/check/evaluate/expect.evaluate

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/expect.evaluate

## Overview

Step "evaluate" expectant


38 changes: 38 additions & 0 deletions docs/module/aws/check/evaluate/expect/artifact.expect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# module/aws/check/evaluate/expect/artifact.expect

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/expect/artifact.expect

## Overview

Artifact collection expectant

## Index

* [blackbox.module.aws.check.evaluate.expect.artifact.collection](#blackboxmoduleawscheckevaluateexpectartifactcollection)

## blackbox.module.aws.check.evaluate.expect.artifact.*

### blackbox.module.aws.check.evaluate.expect.artifact.collection

#### Example

```bash
# Collect a list of artifacts
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.artifact.collection
printenv
/etc/passwd
whoami
any-other-command-output-or-file
ASSERT
```

_Function has no arguments._

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

39 changes: 39 additions & 0 deletions docs/module/aws/check/evaluate/expect/file.expect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# module/aws/check/evaluate/expect/file.expect

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/expect/file.expect

## Overview

File expressions expectant

## Index

* [blackbox.module.aws.check.evaluate.expect.file.exists](#blackboxmoduleawscheckevaluateexpectfileexists)

## blackbox.module.aws.check.evaluate.expect.file.*

### blackbox.module.aws.check.evaluate.expect.file.exists

#### Example

```bash
# Expression that has the existing file
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.file.exists - "Success %s" "Fail %s" "message"
/etc/passwd
ASSERT
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert failure message
* **$4** (type=...mixed): Assert message args

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

139 changes: 139 additions & 0 deletions docs/module/aws/check/evaluate/expect/shell.expect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# module/aws/check/evaluate/expect/shell.expect

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/expect/shell.expect

## Overview

Shell expressions expectant

## Index

* [blackbox.module.aws.check.evaluate.expect.shell.debug](#blackboxmoduleawscheckevaluateexpectshelldebug)
* [blackbox.module.aws.check.evaluate.expect.shell.failure](#blackboxmoduleawscheckevaluateexpectshellfailure)
* [blackbox.module.aws.check.evaluate.expect.shell.stderr](#blackboxmoduleawscheckevaluateexpectshellstderr)
* [blackbox.module.aws.check.evaluate.expect.shell.stdout](#blackboxmoduleawscheckevaluateexpectshellstdout)
* [blackbox.module.aws.check.evaluate.expect.shell.success](#blackboxmoduleawscheckevaluateexpectshellsuccess)

## blackbox.module.aws.check.evaluate.expect.shell.*

### blackbox.module.aws.check.evaluate.expect.shell.debug

#### Example

```bash
# Debug output
cat <<ASSERT | blackbox.expect.shell.debug
printf "debug message"
ASSERT
```

_Function has no arguments._

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

### blackbox.module.aws.check.evaluate.expect.shell.failure

#### Example

```bash
# Expression that should fail
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.shell.failure - "Success %s" "Fail %s" "message"
true -eq false
ASSERT
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert failure message
* **$4** (type=...mixed): Assert message args

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

### blackbox.module.aws.check.evaluate.expect.shell.stderr

#### Example

```bash
# Expression that should have a stderr
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.shell.stderr - "Success %s" "Fail %s" "message"
command-that-does-not-exist
ASSERT
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert failure message
* **$4** (type=...mixed): Assert message args

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

### blackbox.module.aws.check.evaluate.expect.shell.stdout

#### Example

```bash
# Expression that should have a stdout
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.shell.stdout - "Success %s" "Fail %s" "message"
whoami
ASSERT
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert failure message
* **$4** (type=...mixed): Assert message args

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

### blackbox.module.aws.check.evaluate.expect.shell.success

#### Example

```bash
# Expression that should succeed
cat <<ASSERT | blackbox.module.aws.check.evaluate.expect.shell.success - "Success %s" "Fail %s" "message"
true -eq true
ASSERT
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")
* **$3** (type=string): Assert failure message
* **$4** (type=...mixed): Assert message args

#### Input on stdin

* Assert expression

#### Output on stdout

* Formatted assert

46 changes: 46 additions & 0 deletions docs/module/aws/check/evaluate/score.evaluate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# module/aws/check/evaluate/score.evaluate

https://github.com/ProblemSetters/devops-blackbox/blob/2404/module/aws/check/evaluate/score.evaluate

## Overview

Step "evaluate" score calculator

## Index

* [blackbox.module.aws.check.evaluate.score.calculate](#blackboxmoduleawscheckevaluatescorecalculate)
* [blackbox.module.aws.check.evaluate.score.__init](#blackboxmoduleawscheckevaluatescoreinit)

## blackbox.module.aws.check.evaluate.score.*

### blackbox.module.aws.check.evaluate.score.calculate

#### Example

```bash
# Calculates a score: 10 if success or 0 if failure
blackbox.module.aws.check.evaluate.score.calculate 10
# Calculates a score: automatic average if success or 0 if failure
blackbox.module.aws.check.evaluate.score.calculate -
```

#### Arguments

* **$1** (type=enum<1..100|->): Score value: absolute (if integer) or relative (if "-")

#### Output on stdout

* Calculated score

### blackbox.module.aws.check.evaluate.score.__init

_Function has no arguments._

#### Variables set

* **BLACKBOX_CHECK_EVALUATE_SCORE_CALCULATE_CACHE** (readonly,type=string,default=auto): Path to the question evaluation cache (sets automatically, do not override)

#### See also

* [blackbox.module.aws.check.evaluate.score](#blackboxmoduleawscheckevaluatescore)

Loading