Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Module Test code to support module setup is correct. #122

Merged
merged 1 commit into from
Jan 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ Current
- [Add ability for `ClassScanner` to instantiate arrays](https://github.com/yahoo/fili/pull/107)
* This allows for more robust testing of classes that make use of arrays in their constructor parameters

- [Add module load test code](https://github.com/yahoo/fili/pull/122)
* Code to automatically test module is correctly configured.

### Changed:

- [MetricMaker cleanup and simplification](https://github.com/yahoo/fili/pull/127)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.systemconfig

class BardModuleSetupSpec extends ModuleSetupSpec {

@Override
String getModuleName() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs @Override

return "fili-core"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.systemconfig

import static com.yahoo.bard.webservice.config.ModuleLoader.MODULE_CONFIG_FILE_NAME

import com.yahoo.bard.webservice.config.ConfigResourceLoader
import com.yahoo.bard.webservice.config.SystemConfigProvider

import org.apache.commons.configuration.Configuration

import spock.lang.Specification
import spock.lang.Unroll
/**
* An abstract base TCK test for modules.
* Usage: Subclass this spec, in test/groovy/ packages, implementing getModuleName() with your module's name.
*/
abstract class ModuleSetupSpec extends Specification {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description of what this base spec is for and how to use it would be good.


public static final String MODULE_NAME_KEY = "moduleName"

/**
* Implement this test by supplying a subclass that provides the name of the module
*
* @return The name of the module as configured in moduleConfig.properties
*/
abstract String getModuleName()

@Unroll
def "#moduleName does not break SystemConfig"() {
expect:
SystemConfigProvider.instance.runtimeProperties.getOrDefault("Does getting a property throw an exception?", "foo") == "foo"

where:
moduleName << [getModuleName()]
}

@Unroll
def "ConfigResourceLoader discovers #moduleName"() {
setup:
List<Configuration> configurations = new ConfigResourceLoader().loadConfigurations(MODULE_CONFIG_FILE_NAME)

expect:
configurations.stream().map( {it.getString(MODULE_NAME_KEY)}).anyMatch({it.equals(getModuleName())})
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spacing inside the calls is a little inconsistent.


where:
moduleName << [getModuleName()]
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public class ModuleLoader {
/**
* The file name pattern describing module configuration files.
*/
private static final String MODULE_CONFIG_FILE_NAME = "/moduleConfig.properties";
public static final String MODULE_CONFIG_FILE_NAME = "/moduleConfig.properties";

private static final String MODULE_NAME_IS_TOO_SHORT = "Module name is too short.";

Expand Down