rover-cli 0.1.0

A coding exercise in controlling a set of rovers on mars.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

<div align="center">
  <h1><code>rover-cli</code></h1>
  <strong>
    A coding exercise in controlling a set of rovers on mars.
  </strong>
</div>
<br><br>

## 🛠 Installation

```sh
cargo install rover-cli
```

## 🔋 Usage

**Print output to console:**

```sh
rover-cli foo.txt
```

**Save output to file:**
```sh
rover-cli --output output.txt foo.txt
```

**To see helpful information:**

```sh
rover-cli --help
```

## 💭 Code Choices

 - `--unbounded` command flag is included to allow to the rover to exit the plateau.
 - `isize` is used to represent co-ordinates to allow the rover to pass (0, 0).
 - `fs::read_to_string` is used for simplicity over the more performant but more complex `BufReader`.
 - `RoverControlSatellite` is used for themeatic effect!

## 🔬 Testing

To run tests for the CLI:

```sh
cargo test
```

### Testing Approach

Unit tests that cover basic functionality and possible branches are included, however as this is a coding exercise, 100% coverage has not been aimed for. 

### Generate Coverage Report

**Setup**

```sh
rustup component add llvm-tools-preview &&
cargo install cargo-llvm-cov
```

**Usage**

To create a coverage report:

```sh
cargo llvm-cov
```

To debug a coverage report:

```sh
cargo llvm-cov --html --output-dir coverage
```