Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codacy/codacy-plugins-test
Testing interface for external docker tools
https://github.com/codacy/codacy-plugins-test
codacy docker plugins plugins-test review test test-automation testing testing-tool
Last synced: about 1 month ago
JSON representation
Testing interface for external docker tools
- Host: GitHub
- URL: https://github.com/codacy/codacy-plugins-test
- Owner: codacy
- License: mit
- Created: 2015-07-29T20:09:49.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T08:50:26.000Z (9 months ago)
- Last Synced: 2024-03-23T01:45:09.782Z (9 months ago)
- Topics: codacy, docker, plugins, plugins-test, review, test, test-automation, testing, testing-tool
- Language: Scala
- Homepage:
- Size: 12.6 MB
- Stars: 6
- Watchers: 17
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.codacy.com/gh/codacy/codacy-plugins-test?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-plugins-test&utm_campaign=Badge_Grade)
[](https://circleci.com/gh/codacy/codacy-plugins-test)
# Codacy Plugins Test
Provide a testing interface for the external docker tools.
## Test definition
The test files should be placed in `/docs/tests` on the docker of the tool being tested.
**Definition**
```javascript
//#Patterns: : { "": "" }
var people = {};
//#:
for (var i = 0, person; (person = people[i]); i++) {}
var variable;
function test() {
//#:
return (variable = "test");
}
```
**Example:**
```javascript
//#Patterns: boss
var people = {};
//#Warn: boss
for (var i = 0, person; (person = people[i]); i++) {}
var variable;
function test() {
//#Warn: boss
return (variable = "test");
}
```
You can also look for multiple patterns in the same file, just separate them
with a comma:
**Example:**
```javascript
//#Patterns: big, boss
var people = {};
//#Warn: big
for (var i = 0, person; (person = people[i]); i++) {}
var variable;
function test() {
//#Warn: boss
return (variable = "test");
}
```
Instead of commenting in the line before the error, you can alternatively
specify the line of the warning with this syntax:
#Issue: {"severity": "", "line": , "patternId": "PATTERN_ID"}
**Example:**
```javascript
//#Patterns: design_tag_todo
//#Issue: {"severity": "Info", "line": 3, "patternId": "design_tag_todo"}
var people = {};
//TODO: remove empty for
for (var i = 0, person; (person = people[i]); i++) {}
var variable;
```
## Multiple test definition
The multiple tests are defined inside the `/docs/tests/multiple-tests/` directory of the tool's docker image being tested.
You can have a subdirectory of `/docs/tests/multiple-tests/` for every run of the tool.
For example, you can add two subdirectories like these:
- `with-config-file`
- `without-config-file`
To check that the tool works with native configuration file (for example `.eslintrc.json`) and with Codacy configuration.
Each test folder should have a `src` directory (containining the source files to test and the tool's native
configuration (if it exists)), two files named `patterns.xml` and `results.xml` with the following structure:
### `patterns.xml` Structure
```xml
```
### `results.xml` Structure
```xml
```
## Usage
### JsonTests
Checks if the patterns definitions are in the correct format
```sh
sbt "runMain codacy.plugins.DockerTest json :"
```
Options:
- `codacy.tests.ignore.descriptions` - if this variable is defined we do not check if all the patterns have descriptions
### PatternTests
Check if all the patterns defined in the test files occur in the specified line
```sh
sbt "runMain codacy.plugins.DockerTest pattern :"
```
Options:
- `codacy.tests.languages` - languages supported by the tool. If this option isn't provided, the languages
will be inferred from the test files. Example: `-Dcodacy.tests.languages=ruby,java,javascript`
Alternatively, you can run a specific test file:
```sh
sbt "runMain codacy.plugins.DockerTest pattern : no-curly-brackets"
```
### MetricsTests
Check if the metrics defined in the test files match with same complexieties in the specified lines
```sh
sbt "runMain codacy.plugins.DockerTest metrics :"
```
### MultipleTests
Check if the tool runs with multiple patterns and test files at the same time and configuration file behavior as well
```sh
sbt "runMain codacy.plugins.DockerTest multiple :"
```
Options:
- `--only` by adding this flag, followed by the folder name, you can run a single test of the multiple folder ``` sbt "runMain codacy.plugins.DockerTest multiple :" --only ```
## Docs
Information about the integration with external analysis tools at Codacy available [here](https://github.com/codacy/codacy-engine-scala-seed#docs).
## Troubleshooting
> OSx
Change the java tmp dir to your home so that boot2docker can access the tmp files
```sh
-Djava.io.tmpdir=$HOME/tmp
```
## What is Codacy?
[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
### Among Codacy’s features:
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.
### Free for Open Source
Codacy is free for Open Source projects.
## License
Licensed under the MIT License terms.