Backend: Input type validation - type (1/2)
Problem
As a user, I want to ensure that the input I enter when using a component meets the correct format and type so that I can avoid errors or unexpected results when running a CI pipeline
Proposal
By adding an optional subkey type:
and regex:
(#410836 (closed)) we will improve the quality of the data and prevent potential errors, while making the user experience smoother and more reliable.
spec:
inputs:
environment:
type: string/boolean/number # optional
regex: /^gitlab.com/ # optional
when parsing spec: input
we should add a data type validation, and in case of a wrong input we should present the user with the error
Wrong <variable name> input type expected string/boolean/number
open question - should we split regex from type or can we group that in the same MR?
- Effort will be split into this issue and #410836 (closed).
Designs
- Show closed items
Blocks
Relates to
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Dov Hershkovitch changed the description
Compare with previous version changed the description
- Dov Hershkovitch changed milestone to %Backlog
changed milestone to %Backlog
- Dov Hershkovitch added candidate15.11 grouppipeline authoring + 1 deleted label
added candidate15.11 grouppipeline authoring + 1 deleted label
- 🤖 GitLab Bot 🤖 added devopsverify sectionops labels
added devopsverify sectionops labels
- Dov Hershkovitch added workflowplanning breakdown label
added workflowplanning breakdown label
- Mark Nuzzo added backend label
added backend label
- Mark Nuzzo added UI text label
added UI text label
- Mark Nuzzo changed title from Input type validation to Backend: Input type validation
changed title from Input type validation to Backend: Input type validation
- 🤖 GitLab Bot 🤖 added 1 deleted label
added 1 deleted label
- Maintainer
All SUS-impacting issues need to have a proper severity label set. Please add a severity label, remove the automation:ux-missing-labels label, and then reply to this comment briefly explaining your reasoning for providing this severity.
If you are not the DRI for this area and would like help determining the best severity, please @ the appropriate person for assistance.
- 🤖 GitLab Bot 🤖 added automation:ux-missing-labels label
added automation:ux-missing-labels label
- Rayana Verissimo added severity3 label
added severity3 label
- 🤖 GitLab Bot 🤖 removed automation:ux-missing-labels label
removed automation:ux-missing-labels label
- Dov Hershkovitch added to epic &9888 (closed)
added to epic &9888 (closed)
- Maintainer
Setting label(s) Category:Pipeline Composition based on grouppipeline authoring.
- 🤖 GitLab Bot 🤖 added Category:Pipeline Composition label
added Category:Pipeline Composition label
- Dov Hershkovitch mentioned in issue #393401 (closed)
mentioned in issue #393401 (closed)
- Mark Nuzzo added candidate16.0 label and removed candidate15.11 label
added candidate16.0 label and removed candidate15.11 label
- Mark Nuzzo added Category:Component Catalog label
added Category:Component Catalog label
- Laura Montemayor assigned to @lauraX
assigned to @lauraX
- Laura Montemayor unassigned @lauraX
unassigned @lauraX
- Developer
cc @marcel.amirault I'm pinging you for awareness
1 - Sunjung Park added Technical Writing label
added Technical Writing label
- Mark Nuzzo added candidate16.1 label and removed candidate16.0 label
added candidate16.1 label and removed candidate16.0 label
- Leaminn Ma assigned to @lma-git
assigned to @lma-git
- Leaminn Ma unassigned @lma-git
unassigned @lma-git
- Laura Montemayor assigned to @lauraX
assigned to @lauraX
- Maintainer
@dhershkovitch regarding your open question:
should we split regex from type or can we group that in the same MR?
I think we should split this up, we can start with
type
(think this might be simpler) and then go forregex
. Each of these would be a backend-weight3@marknuzzo This issue will be split into two, with a backend-weight3 for each.
Edited by Laura Montemayor Collapse replies - Maintainer
FYI - I removed the
UI text
label since this won't be in the UI. cc @sunjungp 1 - Contributor
Hi @lauraX - I'll create a separate issue then for tracking the related
regex
work here. I'm wondering if it makes sense to do both of these issues at the same time. WDYT?/cc @dhershkovitch
- Maintainer
@marknuzzo - I think that's a good idea, it'll make the feature more "complete" faster :D
1 - Maintainer
@marknuzzo I am taking this issue so I added the
type
to the title of this one. - Contributor
Thanks @lauraX - talking with @dhershkovitch, we also shifted this to the Input Enhancements epic as there will be other input initiatives in the future so grouping them all together makes sense. I also updated #410836 (closed) as well.
- Maintainer
@marknuzzo Ok great, just to confirm - this is still going on 16.1 right?
- Contributor
With issues more prioritized than this issue for %16.1 and the Ops Hackathon, I think we can leave the candidate16.1 on this issue and then bring this into %16.1 if we have capacity. Otherwise, this seems like it will be more in %16.2. WDYT?
/cc @dhershkovitch
- Maintainer
Sounds good @marknuzzo! I see an open issue that is higher priority so I will take that on instead. Thank you!
1
- Laura Montemayor set weight to 3
set weight to 3
- Laura Montemayor added backend-weight3 workflowready for development labels and removed workflowplanning breakdown label
added backend-weight3 workflowready for development labels and removed workflowplanning breakdown label
- Maintainer
@lauraX, thank you for moving this issue to workflowready for development.
Please add a
type::
label to indicate the work type classification.This message was generated automatically. You're welcome to improve it.
- Laura Montemayor removed UI text label
removed UI text label
- Laura Montemayor unassigned @lauraX
unassigned @lauraX
- Mark Nuzzo marked this issue as related to #410836 (closed)
marked this issue as related to #410836 (closed)
- Mark Nuzzo mentioned in issue #410836 (closed)
mentioned in issue #410836 (closed)
- Mark Nuzzo changed the description
Compare with previous version changed the description
- Laura Montemayor assigned to @lauraX
assigned to @lauraX
- Laura Montemayor changed title from Backend: Input type validation to Backend: Input type validation - type (1/2)
changed title from Backend: Input type validation to Backend: Input type validation - type (1/2)
- Mark Nuzzo changed epic to &10603
changed epic to &10603
- Dov Hershkovitch added candidate16.2 label and removed candidate16.1 label
added candidate16.2 label and removed candidate16.1 label
- Laura Montemayor unassigned @lauraX
unassigned @lauraX
- Mark Nuzzo mentioned in issue #396556 (closed)
mentioned in issue #396556 (closed)
- Dov Hershkovitch changed milestone to %16.1
changed milestone to %16.1
- Maintainer
@dhershkovitch - please see the following guidance and update this issue.1 Error Please add typebug typefeature, typemaintenance and a subtype label to this issue. If you do not feel the purpose of this issue matches one of the types, you may apply the typeignore label to exclude it from type tracking metrics and future prompts.
This message was generated automatically. You're welcome to improve it.
- Dov Hershkovitch added typefeature label
added typefeature label
- Avielle Wolfe assigned to @avielle
assigned to @avielle
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#12588 (closed)
mentioned in issue gitlab-org/quality/triage-reports#12588 (closed)
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#12698 (closed)
mentioned in issue gitlab-org/quality/triage-reports#12698 (closed)
- Avielle Wolfe mentioned in merge request !122667 (closed)
mentioned in merge request !122667 (closed)
- Avielle Wolfe added workflowin dev label and removed workflowready for development label
added workflowin dev label and removed workflowready for development label
- Dov Hershkovitch added candidate16.3 label and removed candidate16.2 label
added candidate16.3 label and removed candidate16.2 label
- 🤖 GitLab Bot 🤖 added sectionci label and removed sectionops label
added sectionci label and removed sectionops label
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#12790 (closed)
mentioned in issue gitlab-org/quality/triage-reports#12790 (closed)
- Mark Nuzzo added missed:16.1 label
added missed:16.1 label
- Mark Nuzzo changed milestone to %16.2
changed milestone to %16.2
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#12863 (closed)
mentioned in issue gitlab-org/quality/triage-reports#12863 (closed)
- Ghost User mentioned in issue gl-retrospectives/verify-stage/pipeline-authoring#37 (closed)
mentioned in issue gl-retrospectives/verify-stage/pipeline-authoring#37 (closed)
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#13027 (closed)
mentioned in issue gitlab-org/quality/triage-reports#13027 (closed)
- Avielle Wolfe added workflowready for development label and removed workflowin dev label
added workflowready for development label and removed workflowin dev label
- Maintainer
@dhershkovitch as I'm coding this I realize we haven't decided how to handle null/empty values. Right now we consider them valid, and it might be too restrictive to make them invalid without providing an option to make them valid
I think we should continue to accept null values for any
type
, and later we can introduce anallow_null
keyword (defaulttrue
) that can be set tofalse
to disallow null values. WDYT? Collapse replies - Author Developer
- Maintainer
Excellent
- Avielle Wolfe added workflowin review label and removed workflowready for development label
added workflowin review label and removed workflowready for development label
- Avielle Wolfe mentioned in issue #403301 (closed)
mentioned in issue #403301 (closed)
- Mark Nuzzo mentioned in epic &7462
mentioned in epic &7462
- Fabio Pitino mentioned in merge request !125632 (merged)
mentioned in merge request !125632 (merged)
- Dov Hershkovitch marked this issue as blocking #393401 (closed)
marked this issue as blocking #393401 (closed)
- Fabio Pitino mentioned in issue #418198 (closed)
mentioned in issue #418198 (closed)
- Mark Nuzzo changed milestone to %16.3
changed milestone to %16.3
- Mark Nuzzo added missed:16.2 label
added missed:16.2 label
- Avielle Wolfe added workflowready for development label and removed workflowin review label
added workflowready for development label and removed workflowin review label
- Ghost User mentioned in issue gl-retrospectives/verify-stage/pipeline-authoring#38 (closed)
mentioned in issue gl-retrospectives/verify-stage/pipeline-authoring#38 (closed)
- 🤖 GitLab Bot 🤖 mentioned in issue gitlab-org/quality/triage-reports#13423 (closed)
mentioned in issue gitlab-org/quality/triage-reports#13423 (closed)
- Avielle Wolfe added workflowin review label and removed workflowready for development label
added workflowin review label and removed workflowready for development label
- Avielle Wolfe added workflowin dev label and removed workflowin review label
added workflowin dev label and removed workflowin review label
- Mark Nuzzo mentioned in epic &10969 (closed)
mentioned in epic &10969 (closed)
- Mark Nuzzo mentioned in merge request mbobin/headway!3 (closed)
mentioned in merge request mbobin/headway!3 (closed)
- Mark Nuzzo mentioned in merge request gitlab-org/ci-cd/ops-eng-managers/headway!3 (closed)
mentioned in merge request gitlab-org/ci-cd/ops-eng-managers/headway!3 (closed)
- Avielle Wolfe mentioned in merge request !127762 (merged)
mentioned in merge request !127762 (merged)
- Avielle Wolfe added workflowin review label and removed workflowin dev label
added workflowin review label and removed workflowin dev label
- Maintainer
@lauraX thanks for volunteering to take over this issue while I'm on PTO
1 1 - Avielle Wolfe assigned to @lauraX
assigned to @lauraX
- Mark Nuzzo mentioned in epic &10603
mentioned in epic &10603
- Maintainer
@marknuzzo closing this issue as it has been completed. We can now unblock: #393401 (closed)
cc @avielle
1 1 - Laura Montemayor added workflowcomplete label and removed workflowin review label
added workflowcomplete label and removed workflowin review label
- Laura Montemayor closed
closed
- Avielle Wolfe mentioned in issue #426904 (closed)
mentioned in issue #426904 (closed)