Merge pull request #42 from joselitofilho/new/v0.0.17

New/v0.0.17

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the "ginkgotestexplorer" extension will be documented in this file.
 
+### v0.0.17
+
+- Removes unnecessary cover profile arguments.
+
 ### v0.0.16
 
 - Fixes the use of environment variables on the terminal.

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributing
+
+By participating to this project, you agree to abide our [code of
+conduct](CODE_OF_CONDUCT.md).
+
+**Table of Contents**
+
+- [Setup your machine](#setup-your-machine)
+  - [Using docker](#using-docker)
+- [Generate database](#generate-database)
+- [Run server](#run-server)
+- [Visual Studio Code](#visual-studio-code)
+- [Create a commit](#create-a-commit)
+- [Submit a pull request](#submit-a-pull-request)
+- [Credits](#credits)
+
+## Setup your machine
+
+### Using docker
+
+First time only:
+```bash
+docker-compose build
+```
+
+Run container:
+```bash
+docker-compose up -d
+```
+
+Enter on container:
+```bash
+docker-compose exec server bash
+```
+
+## Visual Studio Code
+
+If you are using VS Code, I strongly recommend you install the following plugin:
+- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) - use a Docker container as a full-featured development environment.
+- [ESLint plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - which will enable you to view ESLint errors directly in your editor.
+
+To unleash the true powers of ESLint and Prettier, we can configure VS Code so that it auto-corrects ESLint errors.
+You should tell VS Code not to formatOnSave, but instead fix ESLint errors on save.
+```json
+// .vscode/settings.json
+{
+    "editor.formatOnSave": false,
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": true
+    }
+}
+```
+
+## Build
+
+Install dependencies:
+```bash
+yarn
+```
+
+## Deploy
+
+Install dependencies:
+```bash
+yarn install
+```
+
+Packages extension:
+```bash
+vsce package
+```
+
+Publishes extension:
+```bash
+vsce pulish
+```
+
+## Create a commit
+
+Commit messages should be well formatted, and to make that "standardized", we
+are using Conventional Commits.
+
+You can follow the documentation on
+[their website](https://www.conventionalcommits.org).
+
+## Submit a pull request
+
+- go to a new branch
+```bash
+git checkout -b feat/my-feature
+```
+- make your changes
+- run tests and linter again 
+```bash
+yarn lint
+```
+- Push your branch to [`surf-king`](https://github.com/board-games-jf/surf-king) repository
+- Open PR against the main branch. 🏄
+
+## Credits
+
+### Contributors
+
+Thank you to all the people who have already contributed to `surf-king`!

package.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/joselitofilho/ginkgoTestExplorer"
   },
-  "version": "0.0.16",
+  "version": "0.0.17",
   "publisher": "joselitofilho",
   "engines": {
     "vscode": "^1.53.0"
@@ -23,6 +23,8 @@
     "Other"
   ],
   "activationEvents": [
+    "onCommand:ginkgotestexplorer.runAllProjectTests",
+    "onCommand:ginkgotestexplorer.generateProjectCoverage",
     "onView:ginkgotestexplorer",
     "onView:ginkgotestfilesexplorer"
   ],

src/ginkgoTest.ts

@@ -67,19 +67,14 @@ export class GinkgoTest {
         this.executeCommandsOn = executeCommandsOn;
     }
 
-    public async runGoTestOnOutputChannel() {
-        const cwd = this.cwd;
-        const coverageDir = this.prepareCoverageDir(cwd);
-        const outputTestFile = `${coverageDir}/${coverageOut}`;
-        const command = `go test -coverpkg=./... -coverprofile=${outputTestFile} -count=1 ./...`;
+    public async runGoTestOnOutputChannel(withCover: boolean) {
+        const command = this.buildGoTestCommand(this.cwd, withCover);
         await this.execGoTestOnOutputChannel(command);
     }
 
-    public async runGoTest() {
+    public async runGoTest(withCover: boolean) {
         const cwd = this.cwd;
-        const coverageDir = this.prepareCoverageDir(cwd);
-        const outputTestFile = `${coverageDir}/${coverageOut}`;
-        const command = `go test -coverpkg=./... -coverprofile=${outputTestFile} -count=1 ./...`;
+        const command = this.buildGoTestCommand(cwd, withCover);
 
         if (this.executeCommandsOn === 'onTerminal') {
             let activeTerminal = vscode.window.terminals.find(t => t.name === gteBash);
@@ -98,7 +93,7 @@ export class GinkgoTest {
         }
     }
 
-    public async runTest(spec: string, document?: vscode.TextDocument): Promise<TestResult[]> {
+    public async runTest(spec: string, withCover: boolean, document?: vscode.TextDocument): Promise<TestResult[]> {
         let cwd = this.cwd;
         if (document) {
             cwd = path.dirname(document.fileName);
@@ -108,7 +103,7 @@ export class GinkgoTest {
 
         const report = `-reportFile ${reportFile}`;
         const focus = `-focus "${spec}"`;
-        const cover = `-cover -coverpkg=./... -coverprofile=${coverageDir}/${coverageOut}`;
+        const cover = withCover ? `-cover -coverpkg=./... -coverprofile=${coverageDir}/${coverageOut}` : '';
         const command = `${this.ginkgoPath} ${report} ${focus} ${cover} -r`;
         let testResults: TestResult[] = [];
         if (this.executeCommandsOn === 'onTerminal') {
@@ -229,6 +224,13 @@ export class GinkgoTest {
         return await this.execCommand('go get github.com/onsi/gomega/...', this.cwd);
     }
 
+    private buildGoTestCommand(cwd: string, withCover: boolean): string {
+        const coverageDir = this.prepareCoverageDir(cwd);
+        const outputTestFile = `${coverageDir}/${coverageOut}`;
+        const coverParams = withCover ? `-coverpkg=./... -coverprofile=${outputTestFile}` : '';
+        return `go test ${coverParams} -count=1 ./...`;
+    }
+
     private getEnv(): { [key: string]: any } {
         const env: { [key: string]: any } = {};
 

src/ginkgoTestExplorer.ts

@@ -84,20 +84,28 @@ export class GinkgoTestExplorer {
     }
 
     private async onRunTestTree(testNode: GinkgoNode) {
-        await this.onRunTest(testNode, 'run');
+        await this.onRunTestTreeCover(testNode, false);
+    }
+
+    private async onRunTestTreeCover(testNode: GinkgoNode, withCover: boolean) {
+        await this.onRunTestCover(testNode, withCover, 'run');
     }
 
     private async onDebugTestTree(testNode: GinkgoNode) {
-        await this.onRunTest(testNode, 'debug');
+        await this.onRunTestCover(testNode, false, 'debug');
     }
 
     private async onRunTest(testNode: GinkgoNode, mode: string) {
+        this.onRunTestCover(testNode, false, mode);
+    }
+
+    private async onRunTestCover(testNode: GinkgoNode, withCover: boolean, mode: string) {
         this.testTreeDataExplorer.provider.prepareToRunTest(testNode);
 
         const editor = vscode.window.activeTextEditor;
         switch (mode) {
             case 'run':
-                await this.ginkgoTest.runTest(testNode.key, editor?.document);
+                await this.ginkgoTest.runTest(testNode.key, withCover, editor?.document);
                 break;
             case 'debug':
                 await this.ginkgoTest.debugTest(testNode.key, editor?.document);
@@ -106,6 +114,10 @@ export class GinkgoTestExplorer {
     }
 
     private async onRunSuiteTest(rootNode: GinkgoNode | undefined) {
+        return this.onRunSuiteTestCover(rootNode, false);
+    }
+
+    private async onRunSuiteTestCover(rootNode: GinkgoNode | undefined, withCover: boolean) {
         // TODO: run simultaneos.
         await new Promise<boolean>(async resolve => {
             outputChannel.clear();
@@ -114,7 +126,7 @@ export class GinkgoTestExplorer {
             }
             if (rootNode) {
                 this.testTreeDataExplorer.provider.prepareToRunTest(rootNode);
-                await this.onRunTestTree(rootNode);
+                await this.onRunTestTreeCover(rootNode, withCover);
                 resolve(true);
             } else {
                 outputChannel.appendLine('Did not run test: no active text editor.');
@@ -130,7 +142,7 @@ export class GinkgoTestExplorer {
             outputChannel.clear();
             outputChannel.appendLine('Running all project tests...');
             try {
-                await this.ginkgoTest.runGoTest();
+                await this.ginkgoTest.runGoTest(false);
             } catch (err) {
                 outputChannel.appendLine(`Error while running all project tests: ${err}.`);
                 reject(err);
@@ -151,7 +163,7 @@ export class GinkgoTestExplorer {
                 this.statusBar.showRunningCommandBar("suite coverage");
 
                 // TODO: Check if there was an error?
-                await this.onRunSuiteTest(rootNode);
+                await this.onRunSuiteTestCover(rootNode, true);
 
                 outputChannel.appendLine('Generating suite coverage results...');
                 try {
@@ -182,7 +194,7 @@ export class GinkgoTestExplorer {
 
             outputChannel.appendLine('Generating project coverage results...');
             try {
-                await this.ginkgoTest.runGoTestOnOutputChannel();
+                await this.ginkgoTest.runGoTestOnOutputChannel(true);
 
                 const output = await this.ginkgoTest.generateCoverage();
                 const viewPanel = vscode.window.createWebviewPanel('Coverage', 'Project coverage result', { viewColumn: vscode.ViewColumn.Two, preserveFocus: true }, { enableScripts: true });