INGEST: Rename Pipeline Processor Param. (#34733)

original-brownbear · web-flow · commit 8e155b8430d0 · 2018-10-23T13:43:26.000+02:00
* `name` is more readable/ergnomic than having `pipeline` twice
diff --git a/modules/ingest-common/src/test/resources/rest-api-spec/test/ingest/210_pipeline_processor.yml b/modules/ingest-common/src/test/resources/rest-api-spec/test/ingest/210_pipeline_processor.yml
@@ -44,7 +44,7 @@ teardown:
           "processors" : [
             {
               "pipeline" : {
-                "pipeline": "inner"
+                "name": "inner"
               }
             }
           ]
@@ -78,7 +78,7 @@ teardown:
           "processors" : [
             {
               "pipeline" : {
-                "pipeline": "inner"
+                "name": "inner"
               }
             }
           ]
@@ -94,7 +94,7 @@ teardown:
           "processors" : [
             {
               "pipeline" : {
-                "pipeline": "outer"
+                "name": "outer"
               }
             }
           ]
diff --git a/modules/ingest-common/src/test/resources/rest-api-spec/test/ingest/90_simulate.yml b/modules/ingest-common/src/test/resources/rest-api-spec/test/ingest/90_simulate.yml
@@ -617,7 +617,7 @@ teardown:
           "processors" : [
             {
               "pipeline" : {
-                "pipeline": "inner"
+                "name": "inner"
               }
             }
           ]
@@ -633,7 +633,7 @@ teardown:
           "processors" : [
             {
               "pipeline" : {
-                "pipeline": "outer"
+                "name": "outer"
               }
             }
           ]
@@ -650,7 +650,7 @@ teardown:
             "processors" : [
             {
               "pipeline" : {
-                "pipeline": "outer"
+                "name": "outer"
               }
             }
             ]
@@ -686,7 +686,7 @@ teardown:
           },
           {
             "pipeline": {
-              "pipeline": "pipeline2"
+              "name": "pipeline2"
             }
           }
           ]
@@ -724,7 +724,7 @@ teardown:
             },
             {
               "pipeline": {
-                "pipeline": "pipeline1"
+                "name": "pipeline1"
               }
             }
             ]
diff --git a/server/src/main/java/org/elasticsearch/ingest/PipelineProcessor.java b/server/src/main/java/org/elasticsearch/ingest/PipelineProcessor.java
@@ -65,7 +65,7 @@ public Factory(IngestService ingestService) {
         public PipelineProcessor create(Map<String, Processor.Factory> registry, String processorTag,
             Map<String, Object> config) throws Exception {
             String pipeline =
-                ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "pipeline");
+                ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "name");
             return new PipelineProcessor(processorTag, pipeline, ingestService);
         }
     }
diff --git a/server/src/test/java/org/elasticsearch/ingest/PipelineProcessorTests.java b/server/src/test/java/org/elasticsearch/ingest/PipelineProcessorTests.java
@@ -62,7 +62,7 @@ public String getTag() {
         when(ingestService.getPipeline(pipelineId)).thenReturn(pipeline);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
         Map<String, Object> config = new HashMap<>();
-        config.put("pipeline", pipelineId);
+        config.put("name", pipelineId);
         factory.create(Collections.emptyMap(), null, config).execute(testIngestDocument);
         assertEquals(testIngestDocument, invoked.get());
     }
@@ -72,7 +72,7 @@ public void testThrowsOnMissingPipeline() throws Exception {
         IngestDocument testIngestDocument = RandomDocumentPicks.randomIngestDocument(random(), new HashMap<>());
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
         Map<String, Object> config = new HashMap<>();
-        config.put("pipeline", "missingPipelineId");
+        config.put("name", "missingPipelineId");
         IllegalStateException e = expectThrows(
             IllegalStateException.class,
             () -> factory.create(Collections.emptyMap(), null, config).execute(testIngestDocument)
@@ -88,21 +88,21 @@ public void testThrowsOnRecursivePipelineInvocations() throws Exception {
         IngestService ingestService = mock(IngestService.class);
         IngestDocument testIngestDocument = RandomDocumentPicks.randomIngestDocument(random(), new HashMap<>());
         Map<String, Object> outerConfig = new HashMap<>();
-        outerConfig.put("pipeline", innerPipelineId);
+        outerConfig.put("name", innerPipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
         Pipeline outer = new Pipeline(
             outerPipelineId, null, null,
             new CompoundProcessor(factory.create(Collections.emptyMap(), null, outerConfig))
         );
         Map<String, Object> innerConfig = new HashMap<>();
-        innerConfig.put("pipeline", outerPipelineId);
+        innerConfig.put("name", outerPipelineId);
         Pipeline inner = new Pipeline(
             innerPipelineId, null, null,
             new CompoundProcessor(factory.create(Collections.emptyMap(), null, innerConfig))
         );
         when(ingestService.getPipeline(outerPipelineId)).thenReturn(outer);
         when(ingestService.getPipeline(innerPipelineId)).thenReturn(inner);
-        outerConfig.put("pipeline", innerPipelineId);
+        outerConfig.put("name", innerPipelineId);
         ElasticsearchException e = expectThrows(
             ElasticsearchException.class,
             () -> factory.create(Collections.emptyMap(), null, outerConfig).execute(testIngestDocument)
@@ -117,7 +117,7 @@ public void testAllowsRepeatedPipelineInvocations() throws Exception {
         IngestService ingestService = mock(IngestService.class);
         IngestDocument testIngestDocument = RandomDocumentPicks.randomIngestDocument(random(), new HashMap<>());
         Map<String, Object> outerConfig = new HashMap<>();
-        outerConfig.put("pipeline", innerPipelineId);
+        outerConfig.put("name", innerPipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
         Pipeline inner = new Pipeline(
             innerPipelineId, null, null, new CompoundProcessor()
@@ -136,11 +136,11 @@ public void testPipelineProcessorWithPipelineChain() throws Exception {
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
 
         Map<String, Object> pipeline1ProcessorConfig = new HashMap<>();
-        pipeline1ProcessorConfig.put("pipeline", pipeline2Id);
+        pipeline1ProcessorConfig.put("name", pipeline2Id);
         PipelineProcessor pipeline1Processor = factory.create(Collections.emptyMap(), null, pipeline1ProcessorConfig);
 
         Map<String, Object> pipeline2ProcessorConfig = new HashMap<>();
-        pipeline2ProcessorConfig.put("pipeline", pipeline3Id);
+        pipeline2ProcessorConfig.put("name", pipeline3Id);
         PipelineProcessor pipeline2Processor = factory.create(Collections.emptyMap(), null, pipeline2ProcessorConfig);
 
         Clock clock = mock(Clock.class);
diff --git a/server/src/test/java/org/elasticsearch/ingest/TrackingResultProcessorTests.java b/server/src/test/java/org/elasticsearch/ingest/TrackingResultProcessorTests.java
@@ -158,7 +158,7 @@ public void testActualPipelineProcessor() throws Exception {
         String pipelineId = "pipeline1";
         IngestService ingestService = mock(IngestService.class);
         Map<String, Object> pipelineConfig = new HashMap<>();
-        pipelineConfig.put("pipeline", pipelineId);
+        pipelineConfig.put("name", pipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
 
         String key1 = randomAlphaOfLength(10);
@@ -204,7 +204,7 @@ public void testActualPipelineProcessorWithHandledFailure() throws Exception {
         String pipelineId = "pipeline1";
         IngestService ingestService = mock(IngestService.class);
         Map<String, Object> pipelineConfig = new HashMap<>();
-        pipelineConfig.put("pipeline", pipelineId);
+        pipelineConfig.put("name", pipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
 
         String key1 = randomAlphaOfLength(10);
@@ -256,7 +256,7 @@ public void testActualPipelineProcessorWithCycle() throws Exception {
         String pipelineId = "pipeline1";
         IngestService ingestService = mock(IngestService.class);
         Map<String, Object> pipelineConfig = new HashMap<>();
-        pipelineConfig.put("pipeline", pipelineId);
+        pipelineConfig.put("name", pipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
 
         PipelineProcessor pipelineProcessor = factory.create(Collections.emptyMap(), null, pipelineConfig);
@@ -277,7 +277,7 @@ public void testActualPipelineProcessorRepeatedInvocation() throws Exception {
         String pipelineId = "pipeline1";
         IngestService ingestService = mock(IngestService.class);
         Map<String, Object> pipelineConfig = new HashMap<>();
-        pipelineConfig.put("pipeline", pipelineId);
+        pipelineConfig.put("name", pipelineId);
         PipelineProcessor.Factory factory = new PipelineProcessor.Factory(ingestService);
 
         String key1 = randomAlphaOfLength(10);

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ teardown:`
`44`	`44`	`"processors" : [`
`45`	`45`	`{`
`46`	`46`	`"pipeline" : {`
`47`		`- "pipeline": "inner"`
	`47`	`+ "name": "inner"`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`]`
`@@ -78,7 +78,7 @@ teardown:`
`78`	`78`	`"processors" : [`
`79`	`79`	`{`
`80`	`80`	`"pipeline" : {`
`81`		`- "pipeline": "inner"`
	`81`	`+ "name": "inner"`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`	`]`
`@@ -94,7 +94,7 @@ teardown:`
`94`	`94`	`"processors" : [`
`95`	`95`	`{`
`96`	`96`	`"pipeline" : {`
`97`		`- "pipeline": "outer"`
	`97`	`+ "name": "outer"`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`	`]`
Original file line number	Diff line number	Diff line change
`@@ -617,7 +617,7 @@ teardown:`
`617`	`617`	`"processors" : [`
`618`	`618`	`{`
`619`	`619`	`"pipeline" : {`
`620`		`- "pipeline": "inner"`
	`620`	`+ "name": "inner"`
`621`	`621`	`}`
`622`	`622`	`}`
`623`	`623`	`]`
`@@ -633,7 +633,7 @@ teardown:`
`633`	`633`	`"processors" : [`
`634`	`634`	`{`
`635`	`635`	`"pipeline" : {`
`636`		`- "pipeline": "outer"`
	`636`	`+ "name": "outer"`
`637`	`637`	`}`
`638`	`638`	`}`
`639`	`639`	`]`
`@@ -650,7 +650,7 @@ teardown:`
`650`	`650`	`"processors" : [`
`651`	`651`	`{`
`652`	`652`	`"pipeline" : {`
`653`		`- "pipeline": "outer"`
	`653`	`+ "name": "outer"`
`654`	`654`	`}`
`655`	`655`	`}`
`656`	`656`	`]`
`@@ -686,7 +686,7 @@ teardown:`
`686`	`686`	`},`
`687`	`687`	`{`
`688`	`688`	`"pipeline": {`
`689`		`- "pipeline": "pipeline2"`
	`689`	`+ "name": "pipeline2"`
`690`	`690`	`}`
`691`	`691`	`}`
`692`	`692`	`]`
`@@ -724,7 +724,7 @@ teardown:`
`724`	`724`	`},`
`725`	`725`	`{`
`726`	`726`	`"pipeline": {`
`727`		`- "pipeline": "pipeline1"`
	`727`	`+ "name": "pipeline1"`
`728`	`728`	`}`
`729`	`729`	`}`
`730`	`730`	`]`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public Factory(IngestService ingestService) {`
`65`	`65`	`public PipelineProcessor create(Map<String, Processor.Factory> registry, String processorTag,`
`66`	`66`	`Map<String, Object> config) throws Exception {`
`67`	`67`	`String pipeline =`
`68`		`- ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "pipeline");`
	`68`	`+ ConfigurationUtils.readStringProperty(TYPE, processorTag, config, "name");`
`69`	`69`	`return new PipelineProcessor(processorTag, pipeline, ingestService);`
`70`	`70`	`}`
`71`	`71`	`}`