Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Missing Cloud Build Attributes #3627

Merged
merged 9 commits into from
Aug 5, 2020
Merged

Adding Missing Cloud Build Attributes #3627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0c5cfb4
adding tags
tanjinP Jun 10, 2020
82c5986
adding the build properties (minus artifacts and options)
tanjinP Jun 11, 2020
c5fe3be
Merge remote-tracking branch 'google/master' into 3576-missing-cloud-…
tanjinP Jul 6, 2020
c19718d
Merge remote-tracking branch 'google/master' into 3576-missing-cloud-…
tanjinP Jul 7, 2020
fa67b48
adding example + test
tanjinP Jul 8, 2020
67d19d9
documentation and rename secrets to secret
tanjinP Jul 8, 2020
75a8217
removing exactly_one_of
tanjinP Jul 17, 2020
2caf210
correcting test example
tanjinP Aug 3, 2020
538232b
making bucket and object for storage source required
tanjinP Aug 5, 2020
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
110 changes: 110 additions & 0 deletions products/cloudbuild/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ objects:
name: 'description'
description: |
Human-readable description of the trigger.
- !ruby/object:Api::Type::Array
name: 'tags'
item_type: Api::Type::String
description: |
Tags for annotation of a BuildTrigger
- !ruby/object:Api::Type::Boolean
name: 'disabled'
description: |
Expand Down Expand Up @@ -241,6 +246,77 @@ objects:
description: |
Contents of the build template. Either a filename or build template must be provided.
properties:
- !ruby/object:Api::Type::NestedObject
name: 'source'
description: |
The location of the source files to build.
properties:
- !ruby/object:Api::Type::NestedObject
name: 'storageSource'
description: |
Location of the source in an archive file in Google Cloud Storage.
properties:
- !ruby/object:Api::Type::String
name: 'bucket'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this and object be required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point - wasn't explicitly called out in REST reference which may explain why I missed it.

required: true
description: |
Google Cloud Storage bucket containing the source.
- !ruby/object:Api::Type::String
name: 'object'
required: true
description: |
Google Cloud Storage object containing the source.
This object must be a gzipped archive file (.tar.gz) containing source to build.
- !ruby/object:Api::Type::String
name: 'generation'
description: |
Google Cloud Storage generation for the object.
If the generation is omitted, the latest generation will be used
- !ruby/object:Api::Type::NestedObject
name: 'repoSource'
description: |
Location of the source in a Google Cloud Source Repository.
properties:
- !ruby/object:Api::Type::String
name: 'projectId'
description: |
ID of the project that owns the Cloud Source Repository.
If omitted, the project ID requesting the build is assumed.
- !ruby/object:Api::Type::String
name: 'repoName'
required: true
description: |
Name of the Cloud Source Repository.
- !ruby/object:Api::Type::String
name: 'dir'
description: |
Directory, relative to the source root, in which to run the build.
This must be a relative path. If a step's dir is specified and is an absolute path,
this value is ignored for that step's execution.
- !ruby/object:Api::Type::Boolean
name: 'invertRegex'
description: |
Only trigger a build if the revision regex does NOT match the revision regex.
- !ruby/object:Api::Type::KeyValuePairs
name: 'substitutions'
description: |
Substitutions to use in a triggered build. Should only be used with triggers.run
- !ruby/object:Api::Type::String
name: 'branchName'
description: |
Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and
described at https://github.com/google/re2/wiki/Syntax
- !ruby/object:Api::Type::String
name: 'tagName'
description: |
Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and
described at https://github.com/google/re2/wiki/Syntax
- !ruby/object:Api::Type::String
name: 'commitSha'
description: |
Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided.
- !ruby/object:Api::Type::Array
name: 'tags'
item_type: Api::Type::String
Expand All @@ -254,6 +330,22 @@ objects:
The images are pushed using the builder service account's credentials.
The digests of the pushed images will be stored in the Build resource's results field.
If any of the images fail to be pushed, the build status is marked FAILURE.
- !ruby/object:Api::Type::KeyValuePairs
name: 'substitutions'
description: |
Substitutions data for Build resource.
- !ruby/object:Api::Type::String
name: 'queueTtl'
description: |
TTL in queue for this build. If provided and the build is enqueued longer than this value,
the build will expire and the build status will be EXPIRED.
The TTL starts ticking from createTime.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- !ruby/object:Api::Type::String
name: 'logsBucket'
description: |
Google Cloud Storage bucket where logs should be written.
Logs file names will be of the format ${logsBucket}/log-${build_id}.txt.
- !ruby/object:Api::Type::String
name: 'timeout'
description: |
Expand All @@ -263,6 +355,24 @@ objects:
The expected format is the number of seconds followed by s.
Default time is ten minutes (600s).
default_value: '600s'
- !ruby/object:Api::Type::Array
name: 'secrets'
description: |
Secrets to decrypt using Cloud Key Management Service.
item_type: !ruby/object:Api::Type::NestedObject
properties:
- !ruby/object:Api::Type::String
name: 'kmsKeyName'
required: true
description: |
Cloud KMS key name to use to decrypt these envs.
- !ruby/object:Api::Type::KeyValuePairs
name: 'secretEnv'
description: |
Map of environment variable name to its encrypted value.
Secret environment variables must be unique across all of a build's secrets,
and must be used by at least one build step. Values can be at most 64 KB in size.
There can be at most 100 secret values across all of a build's secrets.
- !ruby/object:Api::Type::Array
name: 'steps'
required: true
Expand Down
9 changes: 9 additions & 0 deletions products/cloudbuild/terraform.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,22 @@ overrides: !ruby/object:Overrides::ResourceOverrides
- !ruby/object:Provider::Terraform::Examples
name: "cloudbuild_trigger_filename"
primary_resource_id: "filename-trigger"
- !ruby/object:Provider::Terraform::Examples
name: "cloudbuild_trigger_build"
primary_resource_id: "build-trigger"
properties:
id: !ruby/object:Overrides::Terraform::PropertyOverride
name: 'trigger_id'
name: !ruby/object:Overrides::Terraform::PropertyOverride
default_from_api: true
build.steps: !ruby/object:Overrides::Terraform::PropertyOverride
name: 'step'
build.secrets: !ruby/object:Overrides::Terraform::PropertyOverride
name: 'secret'
build.source: !ruby/object:Overrides::Terraform::PropertyOverride
description: |
{{description}}
One of `storageSource` or `repoSource` must be provided.
triggerTemplate: !ruby/object:Overrides::Terraform::PropertyOverride
description: |
{{description}}
Expand Down
34 changes: 34 additions & 0 deletions templates/terraform/examples/cloudbuild_trigger_build.tf.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
resource "google_cloudbuild_trigger" "<%= ctx[:primary_resource_id] %>" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test generated from this example fails:

------- Stdout: -------
=== RUN   TestAccCloudBuildTrigger_cloudbuildTriggerBuildExample
=== PAUSE TestAccCloudBuildTrigger_cloudbuildTriggerBuildExample
=== CONT  TestAccCloudBuildTrigger_cloudbuildTriggerBuildExample
TestAccCloudBuildTrigger_cloudbuildTriggerBuildExample: testing.go:674: Step 0 error: config is invalid: "github": one of `github,trigger_template` must be specified
--- FAIL: TestAccCloudBuildTrigger_cloudbuildTriggerBuildExample (0.46s)
FAIL

My guess is even when that is fixed, the test will probably still fail because some of the references in this example are to things that don't exist. https://github.com/GoogleCloudPlatform/magic-modules#testing-your-changes talks about testing changes. We can run the tests for you, but it's obviously faster if you can iterate on them yourself before sending it back :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh this is strange I thought I did run all the tests and confirm they passed before making PRs ready. Will look at this again this evening 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danawillow okay I see it was because I was testing with the general Terraform provider, when I ran the test on the Terraform beta provider I got the same error. I made a the correction to the test example here and now all tests are passing again 🤷

Anything else to look at?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to note I still need to fill out some of the specific sub resources mentioned in the original ticket. Just want to ensure things are looking good before I proceed and knock the rest out (including a test that includes a comprehensive build example)

trigger_template {
branch_name = "master"
repo_name = "my-repo"
}

build {
step {
name = "gcr.io/cloud-builders/gsutil"
args = ["cp", "gs://mybucket/remotefile.zip", "localfile.zip"]
timeout = "120s"
}

source {
storage_source {
bucket = "mybucket"
object = "source_code.tar.gz"
}
}
tags = ["build", "newFeature"]
substitutions = {
_FOO = "bar"
_BAZ = "qux"
}
queue_ttl = "20s"
logs_bucket = "gs://mybucket/logs"
secret {
kms_key_name = "projects/myProject/locations/global/keyRings/keyring-name/cryptoKeys/key-name"
secret_env = {
PASSWORD = "ZW5jcnlwdGVkLXBhc3N3b3JkCg=="
}
}
}
}
1 change: 1 addition & 0 deletions third_party/terraform/tests/resource_cloudbuild_trigger_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ resource "google_cloudbuild_trigger" "build_trigger" {
args = ["test"]
timeout = "300s"
}
logs_bucket = "gs://mybucket/logs"
}
}
`, name)
Expand Down