Skip to content
A test-driven development way to learn Holochain!
Branch: master
Clone or download
Latest commit e224a2e Apr 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images add tests Feb 19, 2019
test turn off debugLog and make lib.rs intro match solution Apr 12, 2019
zomes/people turn off debugLog and make lib.rs intro match solution Apr 12, 2019
.gitignore prepare tests Feb 19, 2019
.hcignore initial Nov 20, 2018
README.md readme fixes Apr 12, 2019
app.json initial Nov 20, 2018
run-test.sh add tests Feb 19, 2019

README.md

Learn to Build with Holochain Rust

This repository is currently configured to be compatible with Holochain release v0.0.11-alpha1

This repository is a tool for learning about writing apps with Holochain.

It uses a pattern called "test driven development" for teaching. This is where there are predefined "tests", which define how the application should behave, and which functions should exist. When you run the tests, you will see descriptions of that functionality, alongside the expected result.

As a developer in training, it is your job to work to implement the functionality to get the tests passing.

There is boilerplate code already in place so that you can focus on the interesting parts.

Once you make a change in the code, you will rerun the command that runs the tests.

The test file is located in test/index.js.

Instructions

Make sure the Holochain command line development tools are installed

Download this repository to your computer.

Open a terminal.

Change directories in your terminal this apps folder on your computer, wherever it was downloaded to. (Use or lookup cd command if you're not familiar).

You will only have to run the following command once, so run the following in your terminal.

If you are on Windows, open Git Bash, and run the following two commands.

cd test && npm install && cd ..
sh ./run-test.sh

If you are on Mac or Linux, just run

cd test && npm install && cd ..
./run-test.sh

After running the second command, you will see that all the tests are failing.

tests failed

At the moment, all the tests say "unable to call zome function" because the Zome functions don't exist.

Scroll up in your terminal so that you can see the first test. It looks like this: first test failing First, read the description of the test, "use the commit_entry function to add a person entry". Then, compare the "expected: " result, with the "actual: " result. They are different, and we want them to be equal. This will mean implementing the function.

Next, open up a code editor like Atom, Sublime Text, or VSCode, and open this app folder as a project in your editor. From the file tree, open /test/index.js in your code editor. Look at the first test:

const bonnittaAddress = "QmbL7tDsQumvsUTDVZo5mtJknhV6bT28yZDuTdyHQdfqTs"

scenario.runTape("use the commit_entry function to add a person entry", async (t, { alice }) => {
  let result
  try {
    result = alice.call("people", "add_person", { name: "Bonnitta" })
  } catch (e) {}
  t.deepEqual(result, { Ok: bonnittaAddress })
})

What does this all mean?

  • The string "use the commit_entry function to add a person entry" is a description for people to read of what the test is supposed to do
  • alice.call is how we can actually test the exposed functions of our app
  • people is a reference to which Zome this call is to, we have one called "people"
  • add_person is the name of the function which this test calls
  • { name: "Bonnitta" } is the value the test will pass to the function
  • bonnittaAddress is the value we expect calling the function to result in
  • result.Ok indicates that the result of calling our function should be an object which has on it the Ok property with the result
  • t.equal is using the test framework, "tape" to check equality. Note that equal can be used for simple comparisons, while deepEqual should be used to check the equality of objects and arrays

Now, open the file /zomes/people/code/src/lib.rs in your code editor. This will be where you will be working to solve the tests.

Since you should already have taken the tutorial by this point, this activity is more self-directed. Use what you learned in the tutorial to go about adding an add_person function to the define_zome! section, and a handle_add_person function to the code.

Don't forget to add the function into the hc_public trait, either.

When it says to "use commit_entry" function, it means to look up the commit_entry function in the API reference, like this: https://developer.holochain.org/api/0.0.11-alpha1/hdk/api/fn.commit_entry.html. This will tell you how to use this function, what it does, and show you an example. Use that knowledge to write the code to make the function work as expected.

Whatever function or aspect is mentioned in the description of the test, that is your hint for what to look at to make it work.

When you've written the code, go back to the terminal and run the run-test.sh command again, the same as first instructed, without the command that you ran ahead of it (cd .. etc). If you've succeeded, the terminal will say that only 6 tests failed, down from 7, and show this result for the first test, if you scroll up to it. first-test-succeed

Repeat this for all the remaining tests one by one until they are all passing. If you get really stuck, or you've completed it and want to see the solutions, check them out in the solution branch of this repository.

If you open up run-test.sh you will find that it has the following inside

hc test | test/node_modules/.bin/tap-spec

This is the regular hc test command, with its' output piped through "tap-spec" which nicely formats the output. If you just run hc test without that you will find the results less easy to read.

You can’t perform that action at this time.