feat(#11529): throw err if using admin annotation in yaml (#176)

Author: pritamstyz4ever

index.js

@@ -89,6 +89,10 @@ function validateReservedAnnotation(doc) {
                 default: {}
             });
 
+            if (Object.keys(jobAnnotations).some(key => key.startsWith('screwdriver.cd/admin'))) {
+                throw new Error('Annotations starting with screwdriver.cd/admin are reserved for system use only');
+            }
+
             warnings = warnings.concat(
                 Object.keys(jobAnnotations)
                     .filter(key => {

lib/phase/merge.js

@@ -12,7 +12,7 @@ const { merge } = require('./flatten');
  * @method fetchPipelineTemplate
  * @method
  * @param   {String}                          pipelineTemplateName                        Pipeline template name
- * @param   {PipelineTemplateVersionFactory}  config.pipelineTemplateVersionFactory       PiplineTemplateVersion Factory to get pipeline templates
+ * @param   {PipelineTemplateVersionFactory}  config.pipelineTemplateVersionFactory       PipelineTemplateVersion Factory to get pipeline templates
  * @param   {PipelineTemplateTagFactory}      config.pipelineTemplateTagFactory           PipelineTemplateTag Factory to get pipeline templates tag
  * @param   {PipelineTemplateFactory}         config.pipelineTemplateFactory              PipelineTemplate Factory to get pipeline templates
  * @return  {Object}                                                                      Pipeline Template
@@ -337,7 +337,7 @@ function mergeConfig(parsedDoc, pipelineTemplate) {
  * Merge pipeline template with screwdriver yaml
  * @method
  * @param   {Object}                          parsedDoc                                   Document that went through structural parsing
- * @param   {PipelineTemplateVersionFactory}  config.pipelineTemplateVersionFactory       PiplineTemplateVersion Factory to get pipeline templates
+ * @param   {PipelineTemplateVersionFactory}  config.pipelineTemplateVersionFactory       PipelineTemplateVersion Factory to get pipeline templates
  * @param   {PipelineTemplateTagFactory}      config.pipelineTemplateTagFactory           PipelineTemplateTag Factory to get pipeline templates tag
  * @param   {PipelineTemplateFactory}         config.pipelineTemplateFactory              PipelineTemplate Factory to get pipeline templates
  * @returns {Promise}                                                                     Merged pipeline and warnings

test/data/admin-job-annotations.yaml

@@ -0,0 +1,10 @@
+jobs:
+    main:
+        annotations:
+            screwdriver.cd/adminA: c
+        image: node:22
+        steps:
+            - install: npm install
+        requires:
+            - ~pr
+            - ~commit

test/index.test.js

@@ -306,6 +306,14 @@ describe('config parser', () => {
                     assert.deepEqual(data, JSON.parse(loadData('shared-job-annotations.json')));
                 }));
 
+            it('returns error if job has admin annotations', () =>
+                parser({ yaml: loadData('admin-job-annotations.yaml'), triggerFactory }).then(data => {
+                    assert.match(
+                        data.errors[0],
+                        /Error: Annotations starting with screwdriver.cd\/admin are reserved for system use only/
+                    );
+                }));
+
             it('job-level sourcePaths override shared-level sourcePaths', () =>
                 parser({ yaml: loadData('pipeline-with-sourcePaths.yaml'), triggerFactory }).then(data => {
                     assert.deepEqual(data, JSON.parse(loadData('pipeline-with-sourcePaths.json')));