From 81a2cb789162b473668f10258b4a44cdf1faba30 Mon Sep 17 00:00:00 2001
From: temi <temi.varghese@csiro.au>
Date: Wed, 22 May 2024 15:35:57 +1000
Subject: [PATCH] #958 - added a flag to switch off record creation for certain
 protocols

---
 .../au/org/ala/ecodata/ParatooService.groovy  |  3 +-
 .../paratoo/ParatooProtocolConfig.groovy      |  1 +
 .../org/ala/ecodata/ParatooServiceSpec.groovy | 88 +++++++++++++++++++
 3 files changed, 91 insertions(+), 1 deletion(-)

diff --git a/grails-app/services/au/org/ala/ecodata/ParatooService.groovy b/grails-app/services/au/org/ala/ecodata/ParatooService.groovy
index b963f4d8f..d8b3077f2 100644
--- a/grails-app/services/au/org/ala/ecodata/ParatooService.groovy
+++ b/grails-app/services/au/org/ala/ecodata/ParatooService.groovy
@@ -1233,8 +1233,9 @@ class ParatooService {
         ArrayDeque<String> modelVisitStack = new ArrayDeque<>()
         documentation = deepCopy(documentation)
         Map components = deepCopy(getComponents(documentation))
+        boolean record = config.createSpeciesRecord
 
-        Map template = [dataModel: [], viewModel: [], modelName: capitalizeModelName(protocol.attributes.name), record: true, relationships: [ecodata: [:], apiOutput: [:]]]
+        Map template = [dataModel: [], viewModel: [], modelName: capitalizeModelName(protocol.attributes.name), record: record, relationships: [ecodata: [:], apiOutput: [:]]]
         Map properties = deepCopy(findProtocolEndpointDefinition(protocol, documentation))
         if (properties == null) {
             throw new NotFoundException("No protocol endpoint found for ${protocol.attributes.endpointPrefix}/bulk")
diff --git a/src/main/groovy/au/org/ala/ecodata/paratoo/ParatooProtocolConfig.groovy b/src/main/groovy/au/org/ala/ecodata/paratoo/ParatooProtocolConfig.groovy
index ff07b372d..98a02dba7 100644
--- a/src/main/groovy/au/org/ala/ecodata/paratoo/ParatooProtocolConfig.groovy
+++ b/src/main/groovy/au/org/ala/ecodata/paratoo/ParatooProtocolConfig.groovy
@@ -17,6 +17,7 @@ class ParatooProtocolConfig {
     String name
     String apiEndpoint
     boolean usesPlotLayout = true
+    boolean createSpeciesRecord = true
     List tags
     String geometryType = 'Polygon'
 
diff --git a/src/test/groovy/au/org/ala/ecodata/ParatooServiceSpec.groovy b/src/test/groovy/au/org/ala/ecodata/ParatooServiceSpec.groovy
index 1cfd60ac1..83f2c4f5c 100644
--- a/src/test/groovy/au/org/ala/ecodata/ParatooServiceSpec.groovy
+++ b/src/test/groovy/au/org/ala/ecodata/ParatooServiceSpec.groovy
@@ -1549,6 +1549,94 @@ class ParatooServiceSpec extends MongoSpec implements ServiceUnitTest<ParatooSer
         'guid-10' | AccessLevel.admin                | false   | false // Note guid-10 doesn't exist/isn't attached to the project.
     }
 
+    def "buildTemplateForProtocol must switch record generation on or off" (createSpeciesRecord, expected) {
+        setup:
+        def documentation = [
+                components: [schemas: [:]],
+                paths: [
+                        "opportunes/bulk": [
+                                post: [
+                                        requestBody:
+                                                [
+                                                        content: [
+                                                                "application/json": [
+                                                                        schema: [
+                                                                                "properties": [
+                                                                                        "data": [
+                                                                                                "properties": [
+                                                                                                        "collections": [
+                                                                                                                "items": [
+                                                                                                                        "properties": [
+                                                                                                                                "surveyId": [
+                                                                                                                                        "properties": [
+                                                                                                                                                "projectId": [
+                                                                                                                                                        "type": "string"
+                                                                                                                                                ],
+                                                                                                                                                "protocol" : [
+                                                                                                                                                        "properties": [
+                                                                                                                                                                "id"     : [
+                                                                                                                                                                        "type": "string"
+                                                                                                                                                                ],
+                                                                                                                                                                "version": [
+                                                                                                                                                                        "type": "integer"
+                                                                                                                                                                ]
+                                                                                                                                                        ]
+                                                                                                                                                ]
+                                                                                                                                        ]
+                                                                                                                                ]
+                                                                                                                        ]
+                                                                                                                ]
+                                                                                                        ]
+                                                                                                ]
+                                                                                        ]
+                                                                                ]
+                                                                        ]
+                                                                ]
+                                                        ]
+                                                ]
+                                ]
+                        ]
+                ]
+        ]
+        def config = new ParatooProtocolConfig(
+                "name"          : "Opportune",
+                "usesPlotLayout": false,
+                "tags"          : ["survey"],
+                "apiEndpoint"   : "s1s",
+                "overrides"     : [
+                        "dataModel": null,
+                        "viewModel": null
+                ]
+        )
+
+        if (createSpeciesRecord != "DO NOT ADD" ) {
+            config.createSpeciesRecord = createSpeciesRecord
+        }
+
+        def protocol = [
+                attributes: [
+                        endpointPrefix: "opportunes",
+                        workflow: [
+                                [modelName: 'plot-layout'],
+                                [modelName: 'other-model']
+                        ]
+                ]
+        ]
+
+        when:
+        Map result = service.buildTemplateForProtocol(protocol, documentation, config)
+
+        then:
+        result.record == expected
+
+        where:
+        createSpeciesRecord | expected
+        true | true
+        false | false
+        null | false
+        "DO NOT ADD" | true
+    }
+
     private Map getNormalDefinition() {
         def input = """
 {