-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Ben Sherman <[email protected]>
- Loading branch information
1 parent
5439df7
commit bba88f4
Showing
6 changed files
with
399 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
185 changes: 185 additions & 0 deletions
185
src/test/groovy/nextflow/lsp/ast/ASTNodeStringUtilsTest.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| /* | ||
| * Copyright 2013-2024, Seqera Labs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package nextflow.lsp.ast | ||
|
|
||
| import groovy.lang.groovydoc.Groovydoc | ||
| import nextflow.script.dsl.FeatureFlagDsl | ||
| import nextflow.script.dsl.ProcessDirectiveDsl | ||
| import nextflow.script.types.Channel | ||
| import nextflow.script.v2.FeatureFlagNode | ||
| import nextflow.script.v2.FunctionNode | ||
| import nextflow.script.v2.ProcessNode | ||
| import nextflow.script.v2.WorkflowNode | ||
| import org.codehaus.groovy.ast.ClassHelper | ||
| import org.codehaus.groovy.ast.ClassNode | ||
| import org.codehaus.groovy.ast.Parameter | ||
| import org.codehaus.groovy.ast.stmt.EmptyStatement | ||
| import spock.lang.Specification | ||
|
|
||
| /** | ||
| * | ||
| * @author Ben Sherman <[email protected]> | ||
| */ | ||
| class ASTNodeStringUtilsTest extends Specification { | ||
|
|
||
| def 'should get the label and docs for a type' () { | ||
| when: | ||
| def classNode = Mock(ClassNode) { | ||
| isEnum() >> false | ||
| getNameWithoutPackage() >> 'Channel' | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(classNode) == 'type Channel' | ||
|
|
||
| when: | ||
| def enumNode = Mock(ClassNode) { | ||
| isEnum() >> true | ||
| getNameWithoutPackage() >> 'SequenceTypes' | ||
| getGroovydoc() >> Mock(Groovydoc) { | ||
| isPresent() >> true | ||
| getContent() >> '''\ | ||
| /** | ||
| * Enumeration of sequence types. | ||
| */ | ||
| '''.stripIndent(true) | ||
| } | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(enumNode) == 'enum SequenceTypes' | ||
| ASTNodeStringUtils.getDocumentation(enumNode) == 'Enumeration of sequence types.' | ||
| } | ||
|
|
||
| def 'should get the label and docs for a feature flag' () { | ||
| when: | ||
| def ffn = new FeatureFlagNode('nextflow.enable.strict', null) | ||
| ffn.target = new ClassNode(FeatureFlagDsl.class).getDeclaredField('strict') | ||
|
|
||
| then: | ||
| ASTNodeStringUtils.getLabel(ffn) == '(feature flag) nextflow.enable.strict' | ||
| ASTNodeStringUtils.getDocumentation(ffn) == 'When `true`, the pipeline is executed in [strict mode](https://nextflow.io/docs/latest/reference/feature-flags.html).' | ||
| } | ||
|
|
||
| def 'should get the label and docs for a workflow' () { | ||
| when: | ||
| def entry = Mock(WorkflowNode) { | ||
| isEntry() >> true | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(entry) == 'workflow <entry>' | ||
|
|
||
| when: | ||
| def node = Mock(WorkflowNode) { | ||
| isEntry() >> false | ||
| getName() >> 'FOO' | ||
| takes >> EmptyStatement.INSTANCE | ||
| emits >> EmptyStatement.INSTANCE | ||
| getGroovydoc() >> Mock(Groovydoc) { | ||
| isPresent() >> true | ||
| getContent() >> '''\ | ||
| /** | ||
| * Run the FOO workflow. | ||
| */ | ||
| '''.stripIndent(true) | ||
| } | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(node) == ''' | ||
| workflow FOO { | ||
| take: | ||
| <none> | ||
| emit: | ||
| <none> | ||
| } | ||
| '''.stripIndent(true).trim() | ||
| ASTNodeStringUtils.getDocumentation(node) == 'Run the FOO workflow.' | ||
| } | ||
|
|
||
| def 'should get the label and docs for a process' () { | ||
| when: | ||
| def node = Mock(ProcessNode) { | ||
| getName() >> 'BAR' | ||
| inputs >> EmptyStatement.INSTANCE | ||
| outputs >> EmptyStatement.INSTANCE | ||
| getGroovydoc() >> Mock(Groovydoc) { | ||
| isPresent() >> true | ||
| getContent() >> '''\ | ||
| /** | ||
| * Run the BAR process. | ||
| */ | ||
| '''.stripIndent(true) | ||
| } | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(node) == ''' | ||
| process BAR { | ||
| input: | ||
| <none> | ||
| output: | ||
| <none> | ||
| } | ||
| '''.stripIndent(true).trim() | ||
| ASTNodeStringUtils.getDocumentation(node) == 'Run the BAR process.' | ||
| } | ||
|
|
||
| def 'should get the label and docs for a function' () { | ||
| when: | ||
| def node = Spy(new FunctionNode( | ||
| 'sayHello', | ||
| ClassHelper.OBJECT_TYPE, | ||
| [ new Parameter(ClassHelper.OBJECT_TYPE, 'message'), new Parameter(ClassHelper.OBJECT_TYPE, 'target') ] as Parameter[], | ||
| null | ||
| )) | ||
| node.getGroovydoc() >> Mock(Groovydoc) { | ||
| isPresent() >> true | ||
| getContent() >> '''\ | ||
| /** | ||
| * Say hello to someone. | ||
| */ | ||
| '''.stripIndent(true) | ||
| } | ||
| then: | ||
| ASTNodeStringUtils.getLabel(node) == 'sayHello(message, target)' | ||
| ASTNodeStringUtils.getDocumentation(node) == 'Say hello to someone.' | ||
| } | ||
|
|
||
| def 'should get the label and docs for a built-in function' () { | ||
| when: | ||
| def node = new ClassNode(Channel.class).getDeclaredMethods('of').first() | ||
| then: | ||
| ASTNodeStringUtils.getLabel(node) == 'Channel.of(arg0...: T) -> Channel<T>' | ||
| ASTNodeStringUtils.getDocumentation(node) == ''' | ||
| Create a channel that emits each argument. | ||
| [Read more](https://nextflow.io/docs/latest/reference/channel.html#of) | ||
| '''.stripIndent(true).trim() | ||
| } | ||
|
|
||
| def 'should get the label and docs for a process directive' () { | ||
| when: | ||
| def node = new ClassNode(ProcessDirectiveDsl.class).getDeclaredMethods('executor').first() | ||
| then: | ||
| ASTNodeStringUtils.getLabel(node) == '(process directive) executor' | ||
| ASTNodeStringUtils.getDocumentation(node) == ''' | ||
| The `executor` defines the underlying system where tasks are executed. | ||
| [Read more](https://nextflow.io/docs/latest/reference/process.html#executor) | ||
| '''.stripIndent(true).trim() | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.