github.com/icyphox/x@v0.0.355-0.20220311094250-029bd783e8b8/watcherx/integrationtest/README.md (about)

     1  # Integration Test for watcherx/FileWatcher
     2  
     3  As kubernetes has a special way to change mounted config map
     4  values we want to make sure our file watcher is compatible with that.
     5  
     6  ## Perquisites
     7  
     8  The versions are the ones that definitely work.
     9  
    10  - kind (v0.8.1)
    11  - kubectl (v1.18.5)
    12  - docker (v19.03.12-ce)
    13  - make (v4.3)
    14  
    15  ## Structure
    16  
    17  The `main.go` just logs all events it gets. It is deployed to a
    18  kind kubernetes cluster together with a configmap that gets updated
    19  during the test. For details on the test steps have a look at the
    20  `Makefile`.
    21  
    22  ## Running
    23  
    24  To generate the log snapshot run `make snapshot`. That snapshot
    25  should be committed. To check if the FileWatcher works run
    26  `make check`. For debugging purposes single steps of the setup
    27  have descriptive make target names and can be run separately.
    28  It is safe to delete the cluster at any point or rerun snapshot
    29  generation.