Introduction to HonestCode

Hello Honest newcomer!

This course is an introduction to HonestCode from a first time user perspective. It shows how to create your first HonestCode product and acceptance tests, and provides an overview of ATDD and its applications.

• 1. Create your Team…
• 2. Create your Product
• 3. Create your Blueprints
• 4. Features / Scenarios / Steps
• 5. Webhooks

To start log in into pro.HonestCode.io with your Google, GitHub or Salesforce  account (additional accounts providers will be added in the future)

1. Create your Team…

…and invite your people to the Team. Type in their email address, even if they don’t use HonestCode yet, they will receive an email invitation to join your team.

You can assign their roles in the Team:

• ADMIN: can invite new members to the Team and edit everything like a super admin user.
• EDITOR: can create new products and see all the Team’s products.

ADMIN vs. EDITOR roles:

Only ADMIN users can delete a Team and manage account users and roles. ADMIN users can remove and transfer their admin rights from and to other Team users.

2. Create your Product

Create your first Product clicking on ‘+ ADD A NEW PRODUCT’

Now invite your desired Team members to this product. EDITOR users can view all the team products, but to edit a product you need to be a member of that product.

Notice that products members are restricted to Team members.

Members of one team are not allowed to view or edit products of other teams.

3. Create your Blueprints

Blueprints can be defined as the different modules/services/… of your product that has their own repository.  As soon you write your first acceptance tests, you´ll be able to publish your blueprints in your git code repository

If you already have some Gherkin Scenarios written, you can import your .feature files into this Blueprint:

Blueprints of a product can be exported as a ZIP file containing all the tests as “.feature” files with Gherkin syntax. But we recommend to use the ‘Publish now’ button to update all the test files right into the respective repository of you project.

4. Features, Scenarios and Steps

Now you are in ATDD/BDD common ground. Create your acceptance tests with Features, Scenarios and Steps using standard Gherkin syntax. You will find a lot of information and examples online, but a great place to start with a lot of links to useful info is this article with the lessons learned after two years of ATDD. And this Cucumber anti-patterns are pretty useful before you start writing your first Scenarios.

HonestCode will help you suggesting pre-existing similar steps in this Blueprint

All Scenarios can be copied or moved to any Blueprint of the same Product.

After you finish to write your acceptance tests you can publish them to your code repository from the Blueprint screen.

5. Webhooks

To visualize the results in HonestCode, the tests result must be sent to each Blueprint’s test hook.

Configure cucumber to generate an json file output:
–format json:tests_result.json

After test execution, send the generated report to the TESTS HOOK URI that you will in the edit Blueprint page:

curl -XPOST --data-binary @./tests_result.json \
https://pro.honestcode.io/api/hooks/tr/YOUR_TEST_KOOK_KEY -v -s

The HonestCode client is an external tool which helps DevOps to integrate pro.honestcode.io into any CI/CD platforms

All the best from your vulnerable HonestBot