github.com/whamcloud/lemur@v0.0.0-20190827193804-4655df8a52af/uat/README.md (about)

     1  # UAT Manifesto
     2  
     3  Be specific enough to be useful for verifying correct functionality, but don't get deep into technical details. Don't confuse UAT as a replacement for unit/integration tests. 
     4  
     5  Meant to be a contract between programmer and user: This is what the solution can do. The tests prove it. 
     6  
     7  Not necessarily fast enough to run in local CI, but should be fast enough to run in reasonable time (TBD, < 5 min?) before pushing commits. 
     8  
     9  Should not require deep domain knowledge to run tests or interpret results. In other words, the intended user of the solution should not need the programmer's knowledge to run the tests or understand the results.
    10  
    11  Should be able to run anywhere the product is intended to run. Do not require complicated setup or developer environment.
    12  
    13  Keep it simple. Spend time and effort on the UAT code infrastructure so that adding new tests isn't a chore. 
    14  
    15  When failures occur, there should be copious amounts of developer-relevant logs so that finding and reproducing the failure isn't a chore.
    16  
    17  # Configuration
    18  In order to test the s3 mover, the following requirements must be met:
    19  
    20    1. Have a valid AWS account, and an access key/secret
    21    1. Have an existing s3 bucket suitable for testing
    22  
    23  ## Example config
    24  ~/.lhsmd-test:
    25  
    26      aws_access_key_id = "your aws access key"
    27      aws_secret_access_key = "your aws secret key"
    28      s3_region = "us-east-1"
    29      s3_bucket = "your s3 bucket name"
    30  
    31  Check harness/config.go for other configuration options.