README.md 1.77 KB
Newer Older
Samuel Dudík's avatar
Samuel Dudík committed
1
2
# PV260 Project

Samuel Dudík's avatar
Samuel Dudík committed
3
Using .NET 6 and NUnit for testing.
Jakub Koudelka's avatar
Jakub Koudelka committed
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

## How to run project
Our project has cmd interface which can be used with arguments.
By using --help the help output is printed. this outputs:
```
At least one option from group 'output' (c, console, s, slack) is required.

  -o, --old        Required. Input old stock file path.

  -n, --new        Required. Input new stock file path.

  -c, --console    (Group: output) Send output to console

  -s, --slack      (Group: output) Send output to inserted slack uri

  --help           Display this help screen.

  --version        Display version information.
  ```

  ## Examples of running project
  Examples can be run thanks to our launchSettings profiles or manully.
  We have test data in our folder so project can be run on those data.
  Example arguments for propper use with console 
  
  ```-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\april.csv -c``` 
  
  or slack
  
   ```-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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```

   We also include some inproper usage where path or file name doesnt exist
   ```
   wrong path:
   -o .\..\..\..\..\Daa\march.csv -n .\..\..\..\..\Data\april.csv -c
   -o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Daa\april.csv -c
   -o .\..\..\..\..\Dta\march.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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
   ```
   ```
   wrong file:
   -o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\apil.csv -c
   -o .\..\..\..\..\Data\mach.csv -n .\..\..\..\..\Data\april.csv -c
   -o .\..\..\..\..\Data\mach.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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
   ```