cmtc Command Reference

Command Summary

cmtc takes a command as the first parameters and it operates on a studentified CMT main repository.

As the cmtc command operates on a studentified repository, this repository can be passed via the -s option. As this becomes rather laborious after a while, it can be set as a default for subsequent invocations of cmtc with the cmtc set-current-course command. Note that this will 'persist' this setting in the users home folder in the following location: ~/.cmt/cmt.conf.

The available commands and their function is as follows:

The remainder of this section describes these commands in further detail.

cmtc set-current-course

Synopsys

cmtc set-current-course [-h] -s <studentified repo parent folder>

Description

Set the location of the current course making it the default for subsequent invocations of other cmtc commands. For example:

$ cmtc set-current-course -s ~/tmp/stu/lunatech-beginner-quarkus-course-v2
Current course set to '/Users/ericloots/tmp/stu/lunatech-beginner-quarkus-course-v2'

Exercises in repository:
  1.  *   exercise_000_initial_state
  2.      exercise_001_create_a_greeting_service
  3.      exercise_002_a_qute_hello_world
  4.      exercise_003_qute_products
  5.      exercise_004_even_qute_products
  6.      exercise_005_products_from_the_database
  7.      exercise_006_CDI_and_ArC
  8.      exercise_007_Convert_endpoints_to_JSON
  9.      exercise_008_Adding_REST_data_Panache
 10.      exercise_009_Hook_up_the_React_app
 11.      exercise_010_Validation_and_PUT
 12.      exercise_011_Going_Reactive
 13.      exercise_012_Reactive_search_endpoint
 14.      exercise_013_Listen_and_Notify
 15.      exercise_014_Internal_Channels
 16.      exercise_015_Connecting_to_Kafka
 17.      exercise_016_Dead_Letter_Queue_and_Stream_filtering

The following option is available:

    -h: Print command-specific help.

cmtc list-exercises

Synopsys

cmtc list-exercises [-h] -s <studentified repo parent folder>

Description

Generate a list of all exercises in the exercise series. A * is used to indicate the exercise that is currently active. For example (assuming the current course has been set via cmtc set-current-course -s ...):

$ cmtc list-exercises
  1.      exercise_001_initial_state
  2.      exercise_002_a_qute_hello_world
  3.  *   exercise_003_qute_products
  4.      exercise_004_even_qute_products
  5.      exercise_005_products_from_the_database
  6.      exercise_006_CDI_and_ArC
  7.      exercise_007_Convert_endpoints_to_JSON
  8.      exercise_008_Adding_REST_data_Panache
  9.      exercise_009_Hook_up_the_React_app
 10.      exercise_010_Validation_and_PUT
 11.      exercise_011_Going_Reactive
 12.      exercise_012_Reactive_search_endpoint
 13.      exercise_013_Listen_and_Notify
 14.      exercise_014_Internal_Channels
 15.      exercise_015_Connecting_to_Kafka
 16.      exercise_016_Dead_Letter_Queue_and_Stream_filtering

This output shows that there are 16 exercises in the repo. It also show their corresponding exercise IDs. We also see that the current active exercise is exercise_003_qute_products.

The following option is available:

    -h: Print command-specific help.

cmtc next-exercise

Synopsys

cmtc next-exercise [-hf] -s <studentified repo parent folder>

Description

Move to the next exercise. This command will pull in the test and README files for the next exercise. Which files are pulled in is defined in settings cmt.test-code-folders and cmt.read-me-files. All other files are left as-is. This command will be part of the normal workflow used by someone solving all exercises in-sequence: After finishing an exercise successfully (by making all tests pass), the student executes the cmtc next-exercise command, which pulls in the instructions and tests for the next exercise and the exercise solving process can continue.

Note: this command will check if any modifications have been made to test code files. If changes are detected, the execution of the command is aborted and an error message is printed that lists the modified files. The student can then decided to either force the move using the -f option, or to move the changed file(s) to a new location. Any custom tests have to be saved in a location that is not part of the configured set of test code folders (see setting cmt.test-code-folders)

The following options are available:

    -f: Force moving to the next exercise.

    -h: Print command-specific help.

cmtc previous-exercise

Synopsys

cmtc previous-exercise [-hf] -s <studentified repo parent folder>

Description

Move to the previous exercise. This command will pull in the test and README files for the previous exercise. Which files are pulled in is defined in settings cmt.test-code-folders and cmt.read-me-files. All other files are left as-is.

Note: this command will check if any modifications have been made to test code files. If changes are detected, the execution of the command is aborted and an error message is printed that lists the modified files. The student can then decided to either force the move using the -f option, or to move the changed file(s) to a new location.

The following options are available:

    -f: Force moving to the previous exercise.

    -h: Print command-specific help.

cmtc pull-solution

Synopsys

cmtc pull-solution [-h] -s <studentified repo parent folder>

Description

The main use case for this command is to help students sync-up while participating in instructor-led courses: if a students gets stuck or runs out of time while doing an exercise, they can catch-up by pulling the solution for the current exercise. In such a situation, most students will want to save the current state of their work before pulling the solution. They can do so by executing the cmtc save-state command before executing cmtc pull-solution. Any saved state can be restored later by means of the cmtc restore-state command.

cmtc pull-solution will pull all files for the current exercise. As a result, all code present in the source code folder will be overwritten.

The following option is available:

    -h: Print command-specific help.

cmtc pull-template

Synopsys

cmtc pull-template [-h] -t <template file or folder> -s <studentified repo parent folder>

Description

This command allows a student to selectively pull a part of the solution for the current exercise.

It is useful in the case where an exercise requires supporting code or files (data, ...) that is too complex to have the students create themselves or that are not really relevant in the context of what the course aims to teach.

If the template is a single file, that file will be pulled from the reference solution. If the template is a folder, the folder and its content will be pulled recursively.

The following option is available:

    -h: Print command-specific help.

cmtc goto-exercise

Synopsys

cmtc goto-exercise [-hf] -e <exercise-id> -s <studentified repo parent folder>

Description

Go to a specific exercise in the current exercise series. Test code and read me files for this exercise willbe pulled-in from the reference solution. Any other code or files in the exercise workspace will be left as-is. In general, this has the effect that the current code and the pulled-in tests are uncorrelated and running the tests will probably generate [compilation] errors. Hence, in a typical scenario, running this command is usually followed by running the cmtc pull-solution command to reset the state of the exercise to reference solution.

Note: this command will check if any modifications have been made to test code files. If changes are detected, the execution of the command is aborted and an error message is printed that lists the modified files. The student can then decided to either force the move using the -f option, or to move the changed file(s) to a new location.

The following options are available:

    -f: Force moving to the specified exercise.

    -h: Print command-specific help.

cmtc goto-first-exercise

Synopsys

cmtc goto-first-exercise [-hf] -s <studentified repo parent folder>

Description

Go to the first exercise in the current exercise series. Test code and read me files for the first exercise will be pulled-in from the reference solution. Any other code or files in the exercise workspace will be left as-is. In general, this has the effect that the current code and the pulled-in tests are uncorrelated and running the tests will probably generate [compilation] errors. As with the cmtc goto-exercise command, running this command will usually be followed by running a cmtc pull-solution command.

Note: this command will check if any modifications have been made to test code files. If changes are detected, the execution of the command is aborted and an error message is printed that lists the modified files. The student can then decided to either force the move using the -f option, or to move the changed file(s) to a new location.

The following options are available:

    -f: Force moving to the specified exercise.

    -h: Print command-specific help.

cmtc save-state

Synopsys

cmtc save-state [-h] -s <studentified repo parent folder>

Description

Saves the complete state of the current exercise for later retrieval. For more info on the use-case for this command, read the section of cmtc pull-solution.

Note: only one state can be saved for a given exercise: if the command is executed it will overwrite a previously saved state for that exercise

The following option is available:

    -h: Print command-specific help.

cmtc list-saved-states

Synopsys

cmtc list-saved-states [-h] -s <studentified repo parent folder>

Description

Print a list of exercise IDs for all saved states. For example (assuming the current course has been set via cmtc set-current-course -s ...):

$ cmtc list-saved-states
Saved states available for exercises:

   exercise_003_qute_products
   exercise_011_Going_Reactive

The exercise IDs can be used when one wants to restore a particular exercise's state.

The following option is available:

    -h: Print command-specific help.

cmtc restore-state

Synopsys

cmtc restore-state [-h] -e <exercise-id> -s <studentified repo parent folder>

Description

Restore the state of a previously saved exercise. For more info on the use-case for this command, read the section of cmtc pull-solution.

The following option is available:

    -h: Print command-specific help.

cmtc install

Synopsys

cmtc install [-h] -s <studentified repo reference>

Description

Installs a course from a studentified artifact and set it as the default course for subsequent cmtc command invocations. The studentified repo reference can one of three different forms:

  • A zipped version of a studentified course.
  • A folder containing the studentified course.
  • A published [studentified] release of a course.

In the first two cases, the user (student) already has a local, zipped or unzipped copy of a studentified course. For the third case, the author of the course has published a release in a Github repository, most likely via some form of automation (eg. CI using Github Actions), and following a specific naming convention for the zipped studentified course artifact.

Following are examples of invocations of the cmtc install command for each of the above cases:

Install from zip archive
$ ls -l ~/Downloads/lunatech-scala-2-to-scala3-course-student.zip
-rw-r--r--@ 1 ericloots  staff  696763  7 Jul 09:56 /Users/ericloots/Downloads/lunatech-scala-2-to-scala3-course-student.zip

$ (cd ~/Downloads;cmtc install -s lunatech-scala-2-to-scala3-course-student.zip)
Unzipped 'lunatech-scala-2-to-scala3-course-student.zip' to '/Users/ericloots/Library/Caches/com.lunatech.cmt/Courses'
Current course set to '/Users/ericloots/Library/Caches/com.lunatech.cmt/Courses/LSL-P-lightbend-scala-language-professional'

Exercises in repository:
  1.  *   exercise_000_initial_state
  2.      exercise_001_define_a_class
  3.      exercise_002_define_class_parameters
  4.      exercise_003_promote_class_parameters
  5.      exercise_004_define_a_field
  6.      exercise_005_define_a_method
  <elided>
Install from a folder
$ ls -ld ~/Downloads/lunatech-scala-2-to-scala3-course
drwxr-xr-x@ 7 ericloots  staff  224 11 Mar 19:08 /Users/ericloots/Downloads/lunatech-scala-2-to-scala3-course

$ (cd ~/Downloads;cmtc install -s lunatech-scala-2-to-scala3-course)
$ cmtc install -s LSL-P-lightbend-scala-language-professional
Current course set to '/Users/ericloots/Library/Caches/com.lunatech.cmt/Courses/LSL-P-lightbend-scala-language-professional'

Exercises in repository:
  1.  *   exercise_000_initial_state
  2.      exercise_001_define_a_class
  3.      exercise_002_define_class_parameters
  4.      exercise_003_promote_class_parameters
  5.      exercise_004_define_a_field
  6.      exercise_005_define_a_method
  <elided>
Install from a published release on Github
$ cmtc install -s lunatech-labs/lunatech-scala-2-to-scala3-course
downloading studentified course from 'https://github.com/lunatech-labs/lunatech-scala-2-to-scala3-course/releases/download/3.0.0-v1/lunatech-scala-2-to-scala3-course-student.zip' to courses directory
lunatech-scala-2-to-scala3-course (3.0.0-v1) successfully installed to /Users/ericloots/Library/Caches/com.lunatech.cmt/Courses/lunatech-scala-2-to-scala3-course
Current course set to '/Users/ericloots/Library/Caches/com.lunatech.cmt/Courses/LSL-P-lightbend-scala-language-professional'

Exercises in repository:
  1.  *   exercise_000_initial_state
  2.      exercise_001_define_a_class
  3.      exercise_002_define_class_parameters
  4.      exercise_003_promote_class_parameters
  5.      exercise_004_define_a_field
  6.      exercise_005_define_a_method
  <elided>

The following option is available:

    -h: Print command-specific help.

← cmtaCMT configuration →