cyber-dojo / cyber-dojo

home repo for the cyber-dojo organization

Hi. Welcome to cyber-dojo 😄

• cyber-dojo is where programmers meet to practice programming, either individually, or in a group.
• cyber-dojo is not an IDE, an Individual Development Environment
• cyber-dojo is an IDE, an Interactive Dojo Environment!
• cyber-dojo is about shared learning
• in a cyber-dojo you practice by going slower and focusing on improving rather than finishing
• this video explains how to use it for individual TDD practice: https://youtu.be/lIRF8MgyXho
• this video explains how to use it for group TDD practice: https://youtu.be/OGGk-iFVOPQ
• cyber-dojo foundation is a registered Scottish Charitable Incorporated Organisation
• How can I contribute to developing cyber-dojo?

---

• Running a server
  • on Kubernetes
  • on docker
  • on docker swarm
• Versioning
  • listing the current version
  • listing installed versions
  • updating the server to the latest version
  • setting the server to a specific version
• Overriding the default...
  • port
  • start-point images
  • nginx image
  • rails web image
  • dot env files
• Misc
  • List of MicroServices
  • Image dependencies
  • Domain model
  • Screenshots

---

running a server on Kubernetes

Follow these instructions

---

running a server on docker

Follow these instructions to install the cyber-dojo bash script and to prepare your server.

$ cyber-dojo up
...
$ cyber-dojo version
Version: 0.1.19
   Type: public
...

running a server on docker swarm

This is exploratory only and may be dropped without notice. Follow these instructions to install the cyber-dojo bash script and to prepare your server.

$ export CYBER_DOJO_SWARM=true
$ cyber-dojo up

listing the current version

$ cyber-dojo version
Version: 0.1.23
   Type: public

listing installed versions

From 0.1.50 onwards:

$ cyber-dojo version ls
0.1.49              2019-11-21 21:31:09 +0000 UTC
0.1.48              2019-11-20 12:52:04 +0000 UTC
...
0.1.21              2019-08-07 11:51:48 +0000 UTC
...

updating the server to the latest version

$ cyber-dojo update latest
$ cyber-dojo version
Version: 0.1.49
   Type: public
...
# Now make it live...
$ cyber-dojo up
Using version=0.1.49 (public)
...

setting the server to a specific version

$ cyber-dojo update 0.1.21
$ cyber-dojo version
Version: 0.1.21
   Type: public
...
# Now make it live...
$ cyber-dojo up
Using version=0.1.21 (public)
...

overriding the default port

By default your cyber-dojo server will be on port 80.

• Override this port using the command-line argument --port. Eg

  $ cyber-dojo up --port=8000
  ...
  Using port=8000
  ...

overriding the default start-point images

• The cyber-dojo up command uses three default start-point images (tagged appropriately)
  • --custom=cyberdojo/custom-start-points
  • --exercises=cyberdojo/exercises-start-points
  • --languages=cyberdojo/languages-start-points-common
• You can create and use your own alternative start-point images in place of these defaults if you wish.
  • Read how to create them by running:

    cyber-dojo start-point create --help
    

  • Read how to use them by running:

    cyber-dojo up --help
    

overriding the default nginx image

• By default your cyber-dojo server will use cyberdojo/nginx as its nginx service image (tagged appropriately).
• From 0.1.47 onwards you can override this by exporting two environment variables. Eg

  $ export CYBER_DOJO_NGINX_IMAGE=cucumber/nginx
  $ export CYBER_DOJO_NGINX_TAG=efd7e37
  $ cyber-dojo up ...
  ...
  Using nginx=cucumber/nginx:efd7e37
  ...

overriding the default rails web image

• By default your cyber-dojo server will use cyberdojo/web as its web service image (tagged appropriately).
• From 0.1.28 onwards you can override this by exporting two environment variables. Eg

  $ export CYBER_DOJO_WEB_IMAGE=turtlesec/web
  $ export CYBER_DOJO_WEB_TAG=84d6d0e
  $ cyber-dojo up ...
  ...
  Using web=turtlesec/web:84d6d0e
  ...

overriding the default dot env files

• There are default .env files for the web and nginx services.
• You can override these by exporting two environment variables set to the absolute path of your own .env file. Eg

  $ export CYBER_DOJO_NGINX_ENV=/home/fred/my_nginx.env
  $ export CYBER_DOJO_WEB_ENV=/home/fred/my_web.env
  $ cyber-dojo up
  ...
  Using nginx.env=/home/fred/my_nginx.env (custom)
  Using web.env=/home/fred/my_web.env (custom)
  ...

From 0.1.131 onwards, when an exercise starts a welcome dialog displays traffic-light information. You can turn off this dialog with the following web.env entry:

STARTING_INFO_DIALOG=off

From 0.1.137 onwards, there is an experimental REPL service for Python. You can turn this on with the following web.env entry:

REPL=on

From 0.1.291 onwards, you can turn off the review page's [fork] button with the following web.env entry:

FORK_BUTTON=off

From 0.1.319 onwards, you can turn off the [dashboard] button from the info toolbar with the following web.env entry:

DASHBOARD_BUTTON=off

From 0.1.320 onwards, you can turn off traffic-light prediction with the following web.env entry:

PREDICT=off

---

Micro Services

Each repo in the github cyber-dojo organization builds a single docker image.
The main Amazon ECS backed https://cyber-dojo.org uses:

• custom-start-points
  serves the custom start-points.
• exercises-start-points
  serves the exercises start-points.
• languages-start-points
  serves the languages start-points.
• differ
  diffs two sets of files.
• nginx
  web-proxy, security, images (jpg) cache, and service routing.
• runner
  runs the tests and returns [stdout,stderr,status,timed_out,colour].
• saver
  API to GET/POST group/kata data, e.g., for individual traffic-lights.
• creator Gitlab
  UI to configure and create (or re-enter) a group-exercise or an individual-exercise.
• dashboard
  UX for a group session dashboard of all traffic-lights.
• web
  main UX for coding, testing, and reviewing.

Locally running servers also use:

• commander
  receives commands from the cyber-dojo shell script
• versioner
  holds consistent sets of image tags for all cyber-dojo services

---

Image Dependencies

---

Domain Model

---

Screenshots

cyber-dojo's Issues

Usability suggestion: don't show `:stderr:` in red if no output...

My brain is wired to see 'red' = 'bad' from years of TDD...

So I keep "seeing" failure on every successful run of tests in CyberDojo...

I wonder if it would be possible to add a special case that doesn't show red if stderr is empty.

Example:

migrate CircleCI pipelines to Github Actions

CircleCI provides no way (when using github oAuth) to add new people to the Orgs :-(

new/changed files could be large

The runners now send new/changed text files back to the browser (via web).
These files could be large and need to be truncated by the runner in the same way stdout+stderr is.
Currently stdout+stderr is truncated to 10K. Is this too small? A 10K file is often only about ~250 lines.

add jq

If interested in adding jq as a language option, I've started a repo with three sub-folders, and as far as I understand each subfolder should be a repo in two different orgs.
My testing capabilities are limitted, but it looks pretty good "on my machine".

Output from previous test runs displaying

The output of each round of test runs is stacking and continues to be displayed on subsequent iterations. This issue is resolved when the page is refreshed. Identified using Chrome v66.

Build scripts incorrectly assume all repos have a 'build.sh'

In following the build steps described in dev/README.md, I ran into a problem where build-all.sh was trying to run build.sh scripts that didn't exist. Here's what I think is going on:

1. build-all.sh is sourcing env-var-repos.sh, and this sets the CYBER_DOJO_REPOS to a list of repos.
2. For every repo in CYBER_DOJO_REPOS, build-all.sh cd's to that directory and tries to run build.sh..
3. However, some of those directories (e.g. starter) don't contain a build.sh, and this causes the script to terminate prematurely.

I see at least two possible approaches to fixing this. First, we could modify env-var-repos.sh to only include repos containing build.sh in CYBER_DOJO_REPOS. Or, we could update build-all.sh so that it checks for each potential build.sh before running it.

This second change is very straightforward, and it seems a bit more future-proof insofar as it will automatically pick up new build scripts as they become available.

Cannot generate a new exercise

Hi, guys.

Not sure if this is the proper space, so I apologize in advance if it's the wrong place.

That said, our team uses the Cyber Dojo during our interview process so we can know a bit more about how the developer builds the solution and even know him as a person, because we believe that the code can tell us a lot. But, sadly, today we experienced a problem during the exercise gerenation that made it impossible to create a new one.

Looks like the button below isn't working properly:

Could you take a look at it?

Thanks a lot.

partner request

very much, I would like to contribute my knowledge about devops to the repository, greetings

username github: samuelbarrionuevo

`cyber-dojo up` is looking for the `storer` user which doesn't exist

The instructions in dev/README.md tell me to run build-all.sh followed by cyber-dojo up. If I do this (after working around #1), the cyber-dojo up command fails telling me:

ERROR: for cyber-dojo-storer  Cannot start service storer: linux spec user: unable to find user storer: no matching entries in passwd file

ERROR: for storer  Cannot start service storer: linux spec user: unable to find user storer: no matching entries in passwd file
Encountered errors while bringing up the project.

It looks like I need to create a user named storer somewhere, though I'm not sure if this is on my actual host OS or in a docker container somewhere (if container-specific users are even a thing).

Text file is lost after running a test with a stray '\20' in the file

Summary

Something about my keyboard setup means that if I hit a particular key, then a non-ascii character gets inserted.

If I run the tests without spotting it, here's what happens:

Expected behaviour: error message saying my code is wrong
Actual behaviour: error message saying my code is wrong - and the source file is removed from the list of available files.

It's a windows keyboard attached to a Mac, and the key that on PCs causes the context menu to appear, in cyber-dojo causes a little round circle to appear in the code.

Workaround

This has happened to me 3 times now, in an online course, and each time I have had to use the '+' sign to create a new file, and copy-and-paste the in the file from a previous step, which took a few minutes.

I see now that I can "revert" an earlier step, but either I didn't spot that, at the time - or I tried it, and it didn't seem to re-add the file...

Steps to reproduce

Here's exactly what I did - I suspect some of the middle steps can be removed...

1. Start a new session - I chose C++ with CppUTest and Roman numerals
2. Run the test and confirm they fail
3. Edit HikerTest.cpp to make the failing test pass
4. Accidentally hit a key on my keyboard that puts a '\20' (little round blob) into the source
5. Run the tests

Example

There is an example of this having happened in Step 3 of https://www.cyber-dojo.org/kata/edit/8HV74p

This is the error text in the output window:

:stdout:
compiling AllTests.cpp
compiling HikerTest.cpp

:stderr:
tests/HikerTest.cpp:22:5: error: stray '\20' in program
   22 |     �
      |     ^
make: *** [/cpputest/build/MakefileWorker.mk:511: objs/tests/HikerTest.o] Error 1

:status:
2

And here is a screenshot: notice how the output file refers to HikerTest.cpp but that file is no longer listed in the list of available files:

application of hidden_filenames is less than optimal

Currently the runners collect new/changed text files and send them back to web service which then filters them based on the hidden_filenames manifest.json property.
It would be more efficient to send the hidden_filenames property to the runner and for the runner to filter them in-place.

option+O hotkey not working (Mac)