taler-rust

GNU Taler code in Rust. Largely core banking integrations.
Log | Files | Refs | Submodules | README | LICENSE

README.md (1879B)

      1 # Taler Cyclos Adapter
      2 
      3 Taler adapter for the [Cyclos payment system](https://www.cyclos.org/) v4.16.17.
      4 
      5 ## Harness
      6 
      7 Some tests are not automated and must be run on a real Cyclos backend to ensure the correct behavior of the adapter in real conditions. This is also necessary to ensure we support API upgrades.
      8 
      9 ### Logical tests
     10 
     11 Those tests are exhaustive tests of the worker with failure injection it will send a lot of transactions and therefore should not be made using real money.
     12 
     13 #### Setup
     14 
     15 A [docker-compose.yml](./docker-compose.yml) file is provided for you, you can start it using:
     16 
     17 ```sh
     18 cd taler-cyclos && podman-compose up
     19 ```
     20 
     21 Got to `localhost:8080` and follow the configuration wizard.
     22 
     23 You will need to create two accounts, one for the exchange and one for the client. Both accounts must have the web service enabled (System > Configuration.
     24 s > Channels > Web Services > User access) and some money available. You also need to enable chargeback for user payments (System > Products > Chargeback of payments)
     25 
     26 #### Configuration
     27 
     28 Configure the exchange account like you would in production and add the additional harness config with the client account info:
     29 
     30 ```ini
     31 # dev.json
     32 [cyclos]
     33 CYCLOS_URL = http://localhost:8080/
     34 
     35 [cyclos-harness]
     36 USERNAME = client
     37 PASSWORD = password
     38 ```
     39 
     40 #### Run
     41 
     42 ```sh
     43 cargo run --bin cyclos-harness -- -c dev.conf logic -L DEBUG
     44 ```
     45 
     46 ### Online tests
     47 
     48 Those are lighter tests that perform only a few transactions. It's configured like logical test and can be run on a production environment like [demo.cyclos.org](https://demo.cyclos.org).
     49 
     50 #### Setup
     51 
     52 Create manually two accounts with some money.
     53 
     54 #### Configuration
     55 
     56 ```ini
     57 # dev.json
     58 [cyclos]
     59 CYCLOS_URL = https://demo.cyclos.org/
     60 
     61 [cyclos-harness]
     62 USERNAME = client
     63 PASSWORD = password
     64 ```
     65 
     66 #### Run
     67 
     68 ```sh
     69 cargo run --bin cyclos-harness -- -c dev.conf online -L DEBUG
     70 ```