<commit_before># Tests for SRE


## Directory structure

### Basic structure

     expected  JSON files with expected output of tests
     input     JSON files with input of tests
     output    Output files generated by tests (mainly HTML files)
     src       Source files for tests

### Source directory structure

     src
         base     Common files used by test classes.
         classes  Classes for tests that take input and expected from JSON files.
         tests    Test Classes that run tests via test functions.

### Components of the Input directory

     input
         base        Basic tests for components of the engine.
         clearspeak  Speech tests for clearspeak rules.
         common      Speech tests for common use (e.g., fonts, units)
         mathspeak   Speech tests for mathspeak rules.
         nemeth      Speech tests for (Nemeth) Braille.


### Components of the Expected directory

     expected
         base        Expected values for basic tests.
         locale_1    Expected values for speech tests of locale_1.
                       ....
         locale_n    Expected values for speech tests of locale_n.
        
        
### Conent of Expected directories by locales

     expected
         locale
             clearspeak  Expected values for clearspeak tests
             mathspeak   Expected values for mathspeak tests.
             others      Expected values for all other speech rule tests (e.g., prefix, summary)
             symbols     Expected values for symbol tests (character, function, unit)
           ...
         nemeth
             rules       Expected values for nemeth rules
             symbols     Expected values for symbol tests (character, function, unit)


### Components of the Output directory


     expected
                       Potentially other files (with various extensions).
                       ....
         locale_1    HTML output for speech tests of locale_1.
                       ....
         locale_n    HTML output for speech tests of locale_n.

## Current structure

     expected
    0202  base
    0202  de
    0202 0202  clearspeak
    0202 0202  mathspeak
    0202 0202  others
    0202 0202  symbols
    0202  en
    0202 0202  clearspeak
    0202 0202  mathspeak
    0202 0202  others
    0202 0202  symbols
    0202  es
    0202 0202  mathspeak
    0202 0202  others
    0202 0202  symbols
    0202  fr
    0202 0202  clearspeak
    0202 0202  mathspeak
    0202 0202  others
    0202 0202  symbols
    0202  nemeth
    0202      rules
    0202      symbols
     input
    0202  base
    0202  clearspeak
    0202  common
    0202  mathspeak
    0202  nemeth
     output
    0202  de
    0202  en
    0202 0202  sheets
    0202 0202  symbols
    0202  es
    0202 0202  symbols
    0202  fr
    0202 0202  functions
    0202 0202  sheets
    0202 0202  symbols
    0202 0202  units
    0202  nemeth
    0202      functions
    0202      sheets
    0202      symbols
    0202      units
     src
         base
         classes
         tests<commit_msg>Removes wrong encoding from README.<commit_after># Tests for SRE

Run with
``` shell
make test (ENV=n)
```

`ENV` are optional environment parameters.


## Environment parameters



## Directory structure

### Basic structure

    ├── expected  JSON files with expected output of tests
    ├── input     JSON files with input of tests
    ├── output    Output files generated by tests (mainly HTML files)
    └── src       Source files for tests

### Source directory structure

    └── src
        ├── base     Common files used by test classes.
        ├── classes  Classes for tests that take input and expected from JSON files.
        └── tests    Test Classes that run tests via test functions.

### Components of the Input directory

    └── input
        ├── base        Basic tests for components of the engine.
        ├── clearspeak  Speech tests for clearspeak rules.
        ├── common      Speech tests for common use (e.g., fonts, units)
        ├── mathspeak   Speech tests for mathspeak rules.
        └── nemeth      Speech tests for (Nemeth) Braille.


### Components of the Expected directory

    └── expected
        ├── base        Expected values for basic tests.
        ├── locale_1    Expected values for speech tests of locale_1.
        │               ....
        └── locale_n    Expected values for speech tests of locale_n.
        
        
### Conent of Expected directories by locales

    └── expected
        └── locale
            ├── clearspeak  Expected values for clearspeak tests
            ├── mathspeak   Expected values for mathspeak tests.
            ├── others      Expected values for all other speech rule tests (e.g., prefix, summary)
            └── symbols     Expected values for symbol tests (character, function, unit)
        │   ...
        └── nemeth
            ├── rules       Expected values for nemeth rules
            └── symbols     Expected values for symbol tests (character, function, unit)


### Components of the Output directory


    └── expected
        │               Potentially other files (with various extensions).
        │               ....
        ├── locale_1    HTML output for speech tests of locale_1.
        │               ....
        └── locale_n    HTML output for speech tests of locale_n.

## Current structure

    ├── expected
    │   ├── base
    │   ├── de
    │   │   ├── clearspeak
    │   │   ├── mathspeak
    │   │   ├── others
    │   │   └── symbols
    │   ├── en
    │   │   ├── clearspeak
    │   │   ├── mathspeak
    │   │   ├── others
    │   │   └── symbols
    │   ├── es
    │   │   ├── mathspeak
    │   │   ├── others
    │   │   └── symbols
    │   ├── fr
    │   │   ├── clearspeak
    │   │   ├── mathspeak
    │   │   ├── others
    │   │   └── symbols
    │   └── nemeth
    │       ├── rules
    │       └── symbols
    ├── input
    │   ├── base
    │   ├── clearspeak
    │   ├── common
    │   ├── mathspeak
    │   └── nemeth
    ├── output
    │   ├── de
    │   ├── en
    │   │   ├── sheets
    │   │   └── symbols
    │   ├── es
    │   │   └── symbols
    │   ├── fr
    │   │   ├── functions
    │   │   ├── sheets
    │   │   ├── symbols
    │   │   └── units
    │   └── nemeth
    │       ├── functions
    │       ├── sheets
    │       ├── symbols
    │       └── units
    └── src
        ├── base
        ├── classes
        └── tests
{'fraction_non_alphanumeric': 0.0763014763014763, 'fraction_numerical': 0.04226884226884227, 'mean_word_length': 1.6014551333872271, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3048167', 'n_tokens_mistral': 2126, 'n_tokens_neox': 1912, 'n_words': 786}