kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

1010 test implementation

Browse Source 
Signed-off-by: Guillaume de Rouville <guillaume.derouville@gmail.com>
This commit is contained in:
Guillaume de Rouville 2021-08-13 12:43:13 +02:00
parent 2bcd7a7dbf
commit 00f7e63c4a
4 changed files with 87 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs/learn/1010-dev-cue-package.md
View File

@ -4,10 +4,9 @@ slug: /1010/dev-cue-package/
# Develop a new CUE package for Dagger # Develop a new CUE package for Dagger
This tutorial illustrates how to create new packages, manually distribute them among your applications and contribute to This tutorial illustrates how to create new packages, manually distribute them among your applications and contribute to the Dagger stdlib packages.
the Dagger stdlib packages.
## Creating your own package ## Creating your package
### Initializing workspace ### Initializing workspace
@ -24,7 +23,7 @@ As described in the previous tutorials, initialize your Dagger workspace:
dagger init dagger init
``` ```
That will create 2 directories: `.dagger` and `cue.mod` where our package will reside: That will create two directories: `.dagger` and `cue.mod`, where our package will reside:
```shell ```shell
. .
@ -38,8 +37,8 @@ That will create 2 directories: `.dagger` and `cue.mod` where our package will r
### Writing the package ### Writing the package
Now that you've initialized your workspace it's time to write a simple package. Package name usually starts with a Now that you've initialized your workspace, it's time to write a simple package. Package name usually starts with a
domain name (as in Go) followed with a descriptive name. In this example we reuse the Cloud Run example and create a domain name (as in Go) followed by a descriptive name. In this example, we reuse the Cloud Run example and create a
package from it. package from it.
```shell ```shell
@ -52,69 +51,15 @@ Let's write the package logic. It is basically what we've seen in the 106-cloudr
touch cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue touch cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue
``` ```
```cue title="cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue" ```cue file=./tests/dev-cue-package/source.cue title="cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue"
package gcpcloudrun
import (
"alpha.dagger.io/dagger"
"alpha.dagger.io/docker"
"alpha.dagger.io/gcp"
"alpha.dagger.io/gcp/cloudrun"
"alpha.dagger.io/gcp/gcr"
)
#Run: {
// Source code of the sample application
src: dagger.#Artifact & dagger.#Input
// GCR full image name
imageRef: string & dagger.#Input
image: docker.#Build & {
source: src
}
gcpConfig: gcp.#Config
creds: gcr.#Credentials & {
config: gcpConfig
}
push: docker.#Push & {
target: imageRef
source: image
auth: {
username: creds.username
secret: creds.secret
}
}
deploy: cloudrun.#Service & {
config: gcpConfig
image: push.ref
}
}
``` ```
### Running the package ### Running the package
Now that you've successfully created a package, let's run it in a new environment. Create a new test package using Now that you've successfully created a package let's run it in a new environment. Create a new test package using
our reusable `gcpcloudrun`: our reusable `gcpcloudrun`:
```shell ```cue file=./tests/dev-cue-package/script.sh#L3-L16
mkdir test
cat > test/source.cue << EOF
package test
import (
"github.com/tjovicic/gcpcloudrun"
)
run: gcpcloudrun.#Run
EOF
dagger new staging -p ./test
``` ```
Run it: Run it:
@ -138,7 +83,7 @@ You should see a familiar output:
## Manually distributing packages ## Manually distributing packages
You've probably guessed this package isn't tied to just your workspace. You can easily copy/paste it into any number You've probably guessed this package isn't tied to just your workspace. You can easily copy/paste it into any number
of different workspaces and use it as we've showed above. of different workspaces and use it as we've shown above.
```shell ```shell
mkdir -p /my-new-workspace/cue.mod/pkg/github.com/tjovicic/gcpcloudrun mkdir -p /my-new-workspace/cue.mod/pkg/github.com/tjovicic/gcpcloudrun
@ -147,7 +92,7 @@ cp ./cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue /new-workspace/cue.m
## Contributing to Dagger stdlib ## Contributing to Dagger stdlib
Our [stdlib](https://github.com/dagger/dagger/tree/main/stdlib) has many useful packages that you can use. Our [stdlib](https://github.com/dagger/dagger/tree/main/stdlib) has many valuable packages that you can use.
You've probably seen it when you've initialized your workspace: You've probably seen it when you've initialized your workspace:
```shell ```shell
@ -160,6 +105,5 @@ You've probably seen it when you've initialized your workspace:
│ └── usr │ └── usr
``` ```
We are still a small community and are constantly looking for new contributors that will work with us improve this We are still a small community and are constantly looking for new contributors that will work with us to improve this fantastic project. If you feel like we are missing a package or want to improve an existing one, please start with our
amazing project. If you feel like we are missing a package or want to improve an existing one, please start with our
[contributing docs](https://github.com/dagger/dagger/blob/main/CONTRIBUTING.md) and open a PR. [contributing docs](https://github.com/dagger/dagger/blob/main/CONTRIBUTING.md) and open a PR.

15
docs/learn/tests/dev-cue-package/script.sh Normal file
View File

@ -0,0 +1,15 @@
#!/bin/bash
mkdir test
cat > test/source.cue << EOF
package test
import (
"github.com/tjovicic/gcpcloudrun"
)
run: gcpcloudrun.#Run
EOF
dagger new staging -p ./test

41
docs/learn/tests/dev-cue-package/source.cue Normal file
View File

@ -0,0 +1,41 @@
package gcpcloudrun
import (
"alpha.dagger.io/dagger"
"alpha.dagger.io/docker"
"alpha.dagger.io/gcp"
"alpha.dagger.io/gcp/cloudrun"
"alpha.dagger.io/gcp/gcr"
)
#Run: {
// Source code of the sample application
src: dagger.#Artifact & dagger.#Input
// GCR full image name
imageRef: string & dagger.#Input
image: docker.#Build & {
source: src
}
gcpConfig: gcp.#Config
creds: gcr.#Credentials & {
config: gcpConfig
}
push: docker.#Push & {
target: imageRef
source: image
auth: {
username: creds.username
secret: creds.secret
}
}
deploy: cloudrun.#Service & {
config: gcpConfig
image: push.ref
}
}

21
docs/learn/tests/doc.bats
View File

@ -141,4 +141,23 @@ setup() {
# Prepare and run cloudformation cleanup # Prepare and run cloudformation cleanup
dagger -e cloudformation input text stackRemoval.stackName $stackName dagger -e cloudformation input text stackRemoval.stackName $stackName
dagger -e cloudformation up dagger -e cloudformation up
} }
@test "doc-1010-dev-cue-package" {
setup_example_sandbox ""
# Initializing workspace
mkdir workspace
cd workspace
# Writing the package
dagger init
mkdir -p cue.mod/pkg/github.com/tjovicic/gcpcloudrun
cp $CODEBLOC_SRC/dev-cue-package/source.cue cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue
cp $CODEBLOC_SRC/dev-cue-package/script.sh .
chmod +x script.sh
./script.sh
run dagger up -e staging
assert_output --partial "environment=staging input=run.gcpConfig.serviceKey"
}