Skip to content

Latest commit

 

History

History
224 lines (164 loc) · 6.5 KB

CLION_DOCKER_DEVELOPMENT.md

File metadata and controls

224 lines (164 loc) · 6.5 KB
Raw

CLion / Docker Development

The quickest way to get started developing Conclave is with the following setup which involves Docker and CLion. Conclave has a lot of dependencies and you may not want to clog up your base system with these, so Docker fixes that problem, however, some extra setup is required for CLion to "see into" the docker container and resolve toolchains, libraries, header files, and so forth.

The following setup uses CLion's remote feature which makes CLion behave as if it's running inside the container.

Currently the docker image is based on Ubuntu 18.04. In future we plan to target multiple Unices, Windows, and possibly other OSes.

This guide assumes you already have Docker and CLion installed.

Step 0: Get the Conclave Codebase

You may have done this already. Skip this step if so.

Clone the Conclave codebase from Github:

git clone https://github.com/conclave-network/conclave.git

Step 1: Open the Codebase in CLion

  1. Open CLion.
  2. File > Open.
  3. Navigate to the conclave directory.
  4. Click OK.

Step 2: Build the CLion Development Image

Open a the terminal tab in CLion (located at the bottom of the CLion window) or an external terminal program if you prefer. Execute the following docker build command, which will build the clion-dev stage, creating an image called conclave-clion:

docker build --target clion-dev -t conclave-clion .

This command may take a while - possibly over an hour.

Step 3: Create Development Container

Create a container called conclave-clion-ctr based on the conclave-clion image:

docker create \
  -it \
  --cap-add sys_ptrace \
  -p 127.0.0.1:2222:22 \
  -p 127.0.0.1:8008:8008 \
  --name conclave-clion-ctr \
  conclave-clion

Step 4: Start Development Container

Start the container:

docker start conclave-clion-ctr

Test SSH Connection

The CLion development container contains an SSH server listening on port 22, which is exposed on the docker host as port

  1. It also has a user called conclave with password bitcoin. Ensure you can SSH into the container:
ssh conclave@localhost -p 2222

You may need to run the following command to remove cached SSH keys:

ssh-keygen -f "$HOME/.ssh/known_hosts" -R "[localhost]:2222"

Once you've successfully logged into the container, you can run whoami to ensure you are the conclave user:

$ whoami
conclave

Step 5: Enable Remote Development in CLion

  1. File > Settings > Build, Execution, Deployment > Toolchains.
  2. Click + to add a new configuration and choose Remote Host.
  3. Set Name to conclave-docker.
  4. Press the gear icon beside Credentials to create a new SSH config.
    1. Press + to add a new SSH config.
    2. Set Host to localhost.
    3. Set Port to 2222.
    4. Set User name to conclave.
    5. Set Authentication type to Password
    6. Set Password to bitcoin.
    7. Click Test connection. Ensure it works.
  5. Set CMake to /usr/local/bin/cmake
  6. Set C Compiler to Let Cmake detect
  7. Set C++ Compiler to Let Cmake detect
  8. Set Debugger to Remote host GDB
  9. Wait a few seconds until compilers and debugger are all detected.
  10. Click Apply.
  11. Click OK.

Step 6: Create CMake Profile

  1. File > Settings > Build, Execution, Deployment > CMake.
  2. Highlight the existing Debug profile.
  3. Set Toolchain to conclave-docker.
  4. Click Apply.
  5. Click OK.

Step 7: Wait for Sync

CLion will now start copying files into the container. Wait until it's finished.

Step 8: Set up conclaved Run Configuration

This will make conclaved run with the config inside the codebase's etc directory, so any changes made to etc/conclaved-config.json will immediately be picked up on the next run.

  1. Run > Edit Configurations...
  2. Under CMake Application highlight conclaved.
  3. Set Program arguments to -c ../../etc/conclaved-config.json.
  4. Click Apply.
  5. Click OK.

Step 9: Build conclaved

  1. At the top right of the CMake window, on the right of the green hammer icon, set the active configuration to conclaved | Debug-conclave-docker.
  2. Click the green hammer icon to build conclaved.
  3. Wait for the build to complete.

Step 10: Run conclaved

  1. Open the source file src/conclaved.cpp.
  2. Navigate to the main function.
  3. Click on the green triangle and select Run 'conclaved'.

conclaved should now run and in the Run tab you should see something like:

/tmp/tmp.3x3L2lJ8HH/cmake-build-debug-conclave-docker/bin/conclaved -c ../../etc/conclaved-config.json
CONCLAVE - Scaling Bitcoin Simply.
Copyright (C) 2019-2021 Conclave development team
This software is protected by the GNU General Public License v3
https://www.gnu.org/licenses/gpl-3.0.en.html
https://conclave.network
Current path is: "/tmp/tmp.3x3L2lJ8HH/cmake-build-debug-conclave-docker/bin"
Config loaded from ../../etc/conclaved-config.json
ChainwatchManager ctor
Starting node: Callan
Public key: 021d5219a13f0f23ebbd8e88abe9ab9eac77f9daaa859cfff0580279a15d9aa12b
ChainwatchManager prepare
Starting RPC manager...
Created RPC processor 0
Created RPC processor 1
Created RPC processor 2
Created 3 RPC processors. Starting them now...
RPC dispatcher 0 waiting for next response...
RPC processor 0 waiting for next request...
Started RPC processor 0
RPC processor 1 waiting for next request...
Started RPC processor 1
RPC processor 2 waiting for next request...
Started RPC processor 2
Started 3 RPC processors
RpcAcceptor: listening on 0.0.0.0:8008

Make a test cURL request from your dev machine:

curl -d '{"method": "NodeInfo"}' http://127.0.0.1:8008/

You should get something like:

{
  "DisplayName": "Callan",
  "PublicKey": "021d5219a13f0f23ebbd8e88abe9ab9eac77f9daaa859cfff0580279a15d9aa12b"
}

If you did, congratulations! You're now ready to hack on Conclave!

Cleaning Up

Stopping / Deleting the Container

Stop the container:

docker stop conclave-clion-ctr

Delete the container:

docker rm conclave-clion-ctr

Deleting the Image

If you need to rebuild the image you'll first need to delete it:

docker rmi conclave-clion

Troubleshooting

  • If the run configuration does not appear to be active and you can not see the green hammer icon or other green icons:
    • Ensure the container is running with docker ps | grep conclave-clion-ctr
    • Failing that, File > Reload CMake Project can sometimes help.