Fix: Modified how classname is generated to be usable in sonar

[monasuncion]

These changes will allow assigning of relative path to classnames. Relative path of the test file will be constructed using sonar.tests property and junitReporter "suite" property. I also applied the xml schema change to use this
format (from #26):

< testcase >
< error / >
< /testcase >
< testcase >
< failure />
< /testcase >  

In the case below, test files are located in site-main-php/src/main/webapp/public/js/tests/models directory.

Sonar property example:

sonar.projectName=js
sonar.sources=site-main-php/src/main/webapp/public/js
sonar.projectBaseDir=.
sonar.exclusions=site-main-php/src/main/webapp/public/js/lib/*.js,site-main-php/src/main/webapp/public/js/tests/**/*.php,site-main-php/src/main/webapp/public/js/tests/**/*.js,site-main-php/src/main/webapp/public/js/ec3.3/vendor/**
sonar.javascript.lcov.reportPath=site-main-php/target/coverage/lcov.info
sonar.javascript.jstestdriver.reportsPath=site-main-php/target/surefire-reports/
sonar.tests=site-main-php/src/main/webapp/public/js/tests

Grunt file reporters property example:

reporters: ['junit', 'coverage', 'progress'],
junitReporter: {
    outputDir: $junitResults,
    suite: 'models'
},
coverageReporter: {
    type: 'lcov',
    dir: $coverageOutputDir,
    subdir: '.'
},
preprocessors: {
    'src/main/webapp/public/js/ec3.3/**/*.js': 'coverage',
    'src/main/webapp/public/js/ec3/**/*.js': 'coverage'
},
plugins: [
    'karma-jasmine',
    'karma-phantomjs-launcher',
    'ec-karma-junit-reporter23',
    'karma-coverage'
]

Example junit xml report:

<?xml version="1.0"?>
<testsuite name="PhantomJS 1.9.8 (Linux)" package="models" timestamp="2015-03-10T13:59:23" id="0" hostname="admin" tests="629" errors="0" failures="0" time="11.452">
  <properties>
    <property name="browser.fullName" value="Mozilla/5.0 (Unknown; Linux x86_64) AppleWebKit/534.34 (KHTML, like Gecko) PhantomJS/1.9.8 Safari/534.34"/>
  </properties>
 <testcase name="(C.2) Checks if an empty object is returned when error 404 is encountered" time="0.01" classname="PhantomJS_1_9_8_(Linux).models.ReportCardDialogService_test"/>
 <testcase name="(C.3) Checks if an empty array is returned when error 405 is encountered" time="0.013" classname="PhantomJS_1_9_8_(Linux).models.ReportCardDialogService_test"/>
</testsuite>

[jbarrus]

It looks like this still requires the describe statement to match the filename, e.g.:

something.spec.js

describe('Something Great', function() {
....
});

results in:

 <testcase name="..." time="..." classname="PhantomJS_1_9_8_(Mac_OS_X).Something Great"/>

Sonar looks for a file named "Something Great.js"

I don't really see an easy workaround for this because jasmine doesn't report the filename.

[mdasberg]

And nested describes like this:

describe('x',function() {
    it('should do something with x', function() {}
    describe('y', function() {
        it('should do something with y', function() {}
    }
}

will generate a report like this:

<testsuite name="SomeTest" errors="0" failures="0" tests="2" time="....">
    <testcase name="should do something with x" time="..." classname="PhantomJS_1_9_8_(Mac_OS_X).x"/>
    <testcase name="should do something with y" time="..." classname="PhantomJS_1_9_8_(Mac_OS_X).x y"/>
</testsuite>

[mpellerin42]

When this pull request will be merged ?

I need this in my project, but I can't merge it manually because of continuous integration which do a "npm install" on each build...

Thanks

[jbarrus]

Still hoping to get this merged...

[mdasberg]

I created a grunt plugin which fixes this issue for sonar, by fixing the test repor. It will match each spec to the original files.

Take a look at: https://github.com/mdasberg/grunt-karma-sonar

[dignifiedquire]

@MoziMos sorry for the late feedback and thanks for the contribution, could you please

• add some documentation to the readme
• change the commit message to follow our convention

[dignifiedquire]

@MoziMos does this supersede #26 ?

[jbarrus]

I believe it does.

[monasuncion]

yes it does supersede that pull request. I'll add some documentation to the read me doc and update this pull request. Thanks.

[googlebot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project, in which case you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please let us know the company's name.

[dignifiedquire]

ping @MoziMos

[googlebot]

CLAs look good, thanks!

[monasuncion]

Updated the README.md file. Please review. Thanks!

[dignifiedquire]

Thanks @MoziMos, could you rebase onto the latest master so I can merge it cleanly squash the commits into one, which follows our convention Then I think it's good to be merged

[monasuncion]

Hello done with the rebase to the latest master.

[dignifiedquire]

@MoziMos still need an update to the commit message, and it seems it still won't merge cleanly, are you sure you pulled in the latest master before you rebased?

[googlebot]

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

[googlebot]

CLAs look good, thanks!

[dignifiedquire]

Thanks