feat(crafting-schema): add schema v2 support to cli #2467

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.

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

Jump to bottom

Merged

Piskoo merged 9 commits into chainloop-dev:main from Piskoo:feat-use-contract-v2-for-contract-operations

Oct 28, 2025

Merged

feat(crafting-schema): add schema v2 support to cli #2467

Piskoo merged 9 commits into chainloop-dev:main from Piskoo:feat-use-contract-v2-for-contract-operations

Oct 28, 2025

Conversation

@Piskoo

Copy link

Collaborator

@Piskoo Piskoo commented Oct 14, 2025 •

edited

Loading

Summary

This PR adds support for contract schema v2 in CLI workflow contract create, update, and apply operations.

Note: The default contract body for create will be updated once v2 schema support is available everywhere.

Changes

CLI can now create and update contracts using v2 schema format:

 apiVersion: ...
 kind: ...
 metadata:
 name: ...
 spec:
 ...

Contract name can now be extracted from the v2 field metadata.name, removing the need for the --name flag.
Validation ensures only one name source is provided (either --name flag or metadata.name in the contract).

@Piskoo Piskoo marked this pull request as ready for review

October 14, 2025 12:37

@Piskoo Piskoo requested review from javirln, jiparis and migmartri

October 14, 2025 12:37

@Piskoo Piskoo mentioned this pull request

Oct 17, 2025

feat(crafting-schema): support schema v2 during attestation process #2468

Merged

migmartri

migmartri reviewed

Oct 17, 2025

View reviewed changes

app/cli/cmd/workflow_contract_create.go

cmd.Flags().StringVar(&name, "name", "", "contract name")

err := cmd.MarkFlagRequired("name")

cobra.CheckErr(err)

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

missing validation

app/controlplane/api/controlplane/v1/workflow_contract.proto Outdated

message: "must contain only lowercase letters, numbers, and hyphens."

expression: "this.name == '' || this.name.matches('^[a-z0-9]([-a-z0-9]*[a-z0-9])?$')"

};

option (buf.validate.message).cel = {

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

this validation doesnt mean much in legacy format

app/controlplane/pkg/data/workflowcontract.go

return nil, fmt.Errorf("failed to unmarshal raw body: %w", err)

}

contract.Schema = schema

contract.Schema = parsedContract.Schema

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

This might be broken, because Schema is necessary for compatibility reasons.

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

Old CLIs must keep working with new contracts

app/controlplane/pkg/data/workflowcontract.go Outdated

}

contract.Schema = schema

contract.Schema = parsedContract.Schema

contract.Schemav2 = parsedContract.Schemav2

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

This second option we don't want it.

app/controlplane/internal/service/workflowcontract.go Outdated

}

// extractContractName extracts the contract name from v2 metadata or returns the fallback name

func extractContractName(rawContract []byte, name string) (string, error) {

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

validate that exactly one item is present

app/controlplane/pkg/biz/workflowcontract.go

if _, err := uc.findAndValidatePolicy(att, token); err != nil {

return NewErrValidation(err)

switch {

case c.isV1Schema():

Copy link

Member

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

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

mark as deprecated

@Piskoo Piskoo marked this pull request as draft

October 20, 2025 07:08

@Piskoo Piskoo mentioned this pull request

Oct 20, 2025

feat(cli): extend workflow contract with apply #2469

Merged

@Piskoo Piskoo force-pushed the feat-use-contract-v2-for-contract-operations branch from 3918cc5 to 39deb09 Compare

October 21, 2025 11:53

@Piskoo Piskoo marked this pull request as ready for review

October 22, 2025 08:16

jiparis

jiparis reviewed

Oct 22, 2025

View reviewed changes

app/controlplane/pkg/biz/workflowcontract.go Show resolved Hide resolved

jiparis

jiparis reviewed

Oct 22, 2025

View reviewed changes

app/controlplane/pkg/data/workflowcontract.go

} else if len(w.Body) == 0 {

schema := &schemav1.CraftingSchema{}

err := unmarshal.FromRaw(w.RawBody, w.RawBodyFormat, schema, false)

parsedContract, err := biz.UnmarshalAndValidateRawContract(w.RawBody, w.RawBodyFormat)

Copy link

Member

@jiparis jiparis Oct 22, 2025

Choose a reason for hiding this comment

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

This looks awkward. Data layer shouldn't call biz layer logic.

Copy link

Collaborator Author

@Piskoo Piskoo Oct 23, 2025

Choose a reason for hiding this comment

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

https://github.com/chainloop-dev/chainloop/blob/main/app/controlplane/pkg/data/workflowcontract.go#L354
That is already the case currently

Copy link

Member

@jiparis jiparis Oct 28, 2025

Choose a reason for hiding this comment

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

I see, let's address it in another PR then.

jiparis

jiparis approved these changes

Oct 28, 2025

View reviewed changes

Copy link

Member

@jiparis jiparis left a comment •

edited

Loading

Choose a reason for hiding this comment

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

I've been testing this locally with different server/client version combinations without any issue.

Piskoo added 9 commits

October 28, 2025 12:06

@Piskoo


 use contract v2 for contract operations

bd2990b

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 fix validation and update for v2 schema

232174b

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 lint

0a9563f

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 lint

8263dce

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 test fix

56207ec

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 fix validation and compatibility issues

408c9ca

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 lint

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 add name validation in service

5609fe3

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo


 update error messages

a2824ae

Signed-off-by: Sylwester Piskozub <sylwesterpiskozub@gmail.com>

@Piskoo Piskoo force-pushed the feat-use-contract-v2-for-contract-operations branch from 0dcd82f to a2824ae Compare

October 28, 2025 11:06

@Piskoo Piskoo merged commit f355374 into chainloop-dev:main

Oct 28, 2025

13 checks passed

Labels

None yet

3 participants

@Piskoo @migmartri @jiparis

feat(crafting-schema): add schema v2 support to cli #2467

feat(crafting-schema): add schema v2 support to cli #2467

Uh oh!

Conversation

@Piskoo Piskoo commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

@migmartri migmartri Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

@jiparis jiparis Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

@Piskoo Piskoo Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

@jiparis jiparis Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

@jiparis jiparis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

@Piskoo Piskoo commented Oct 14, 2025 •

edited

Loading

@jiparis jiparis left a comment •

edited

Loading