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.

Sign up for GitHub

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

Jump to bottom

test(api): add integration tests #21

Merged
merged 9 commits into from
Apr 21, 2018
Merged

test(api): add integration tests #21

merged 9 commits into from
Apr 21, 2018

Conversation

gregswindle
Copy link
Contributor

@gregswindle gregswindle commented Apr 18, 2018 •
edited
Loading

Pull request (PR)

  1. Create API/integration tests lib/__apis__/ directory
  2. Add Jest/Jasmine specs without mocks
  3. Invoke real APIs for results

Associated issue(s)

Closes #18

  • 1. The acceptance criteria for all associated issues have been completed, tested, and validated.
  • 2. The README either reflects my changes or does not require updates.
  • 3. The CONTRIBUTING document either reflects my changes or does not require updates.

Souce code analysis

Code quality summary

Measure Scores
Quality gate Overall Quality
Complexity Complexity
Cognitive complexity
Complexity per Class
Complexity per file
Complexity per Function
Duplications Duplications
Issues Issues
Maintainability Code smells
Maintainability
Technical debt
Reliability Reliability
Security Security
Vulnerabilities
Test coverage Coverage Status
Coveralls coverage

Code quality, vulnerability, and standards compliance tools

Code Style Linters Test frameworks
JavaScript Style Guide ESLint Jest BDD
Standard JS user guide link-external ESlint user guide link-external Jest user guide link-external

How to format, lint, and test your changes

Open a Terminal, go to the root directory for readme-inspector, and run:

$ npm test

info Completed tasks are not required to open a PR, and may be addressed while the PR is open.

alert All tasks must be completed and verified before a PR may be merged into master, however.

@gregswindle
test(api): add integration tests
4bdea05 
1. Create the lib/__apis__/ directory
2. Add Jest/Jasmine specs without mocks
3. Invoke real APIs for results

GH-18
@gregswindle gregswindle added priority: high Affects consumer retention or product reputation. status: accepted The proposal has community consensus type: breaking change Modifications affect or replace the public API. ⇧ Bumps the MAJOR semver. type: docs Add, edit, or delete instructional material. type: chore Changes that don't modify source or test files. type: refactor Restructuring source code without changing its external behavior. type: fix Defect repairs. ⇧ Bumps the PATCH semver. type: test Adding, correcting, or improving tests (coverage). labels Apr 18, 2018
@gregswindle gregswindle added this to the Bitbucket repo README inspection (v1.1.0) milestone Apr 18, 2018
@gregswindle gregswindle self-assigned this Apr 18, 2018
@coveralls
Copy link

coveralls commented Apr 18, 2018 •
edited
Loading

Coverage Status

Coverage remained the same at 100.0% when pulling cb6534d on GH-19-defect-apis into ad96ea5 on master.

@gregswindle
fix(score): verify appraisal initialization
fd87a8b 
BREAKING CHANGE: two method signatures and one property name have changed.

**Objects & Properties**

1. readmeInspector.ReadmeScore - refactor:rename ReadmeScore ➡️  ReadmeAppraisal
2. module:readme-inspector/readme-score - refactor:rename 'ReadmeScore'
   module:readme-inspector/readme-appraisal 'ReadmeAppraisal', which is now
   a class.

**Functions**

1. getReadmeInfo
1.1. Function name - refactor:rename ➡️  getInfo
1.2. Function signature - now expects a params object literal

2. getReadmeScore
2.1. Function name - refactor:rename ➡️  getAppraisal
2.2. Function signature remains the same as in 1.x.x.

3. check's signature now expects a params object literal,
   which it passes to getInfo.

**API tests**

Add API (integration) tests.

GH-18,GH-21
@commonality commonality deleted a comment Apr 19, 2018
@gregswindle
docs(readme): revise func signatures
6362394 
Also creaetd four ENV variables on Appveyor.

GH-18,GH-21
@gregswindle
chore(pkg): customize greenkeeper commit msgs
c4a4971 
- Use commonality branding colors for 'Request a Feature' and
  'Report a Defect' badges
- Move DEVELOPERS.md user the /docs/project/ directory
- Add secure variables to  for API testing
- Iterate through filepaths with markdown files that require
  automated content generation

GH-18,GH-21
@gregswindle
ci(windows): add all env variables
98aa629 
GH-18,GH-21
@gregswindle gregswindle modified the milestones: Bitbucket repo README inspection (v1.1.0), Fix ReadmeScore Apr 21, 2018
@gregswindle gregswindle merged commit 96546fe into master Apr 21, 2018
@gregswindle gregswindle deleted the GH-19-defect-apis branch April 21, 2018 07:34
@gregswindle
Copy link
Contributor Author

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gregswindle gregswindle removed the help wanted Contributions welcome or extra attention needed. label May 2, 2018
@gregswindle gregswindle removed status: available Voluntary contributions welcome ♥! status: review needed Needs community inspection or approval. labels May 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@gregswindle gregswindle

Labels
priority: high Affects consumer retention or product reputation. status: accepted The proposal has community consensus type: breaking change Modifications affect or replace the public API. ⇧ Bumps the MAJOR semver. type: chore Changes that don't modify source or test files. type: docs Add, edit, or delete instructional material. type: fix Defect repairs. ⇧ Bumps the PATCH semver. type: refactor Restructuring source code without changing its external behavior. type: test Adding, correcting, or improving tests (coverage).
Projects
None yet
Milestone
Fix ReadmeScore
Development

Successfully merging this pull request may close these issues.

defect(readme-score): scoreData is always a NullObject (score === 0)
2 participants
@gregswindle @coveralls