Skip to content

testing.md

Latest commit

 

History

History
39 lines (33 loc) · 2.67 KB

testing.md

File metadata and controls

39 lines (33 loc) · 2.67 KB

Testing Configuration

  • In Visual Studio (or other Test UI such as AxoCover), set execution environment to 64-bit to ensure tests load.

  • Units tests are for discreet function testing or limited component dependency tests.

    • CertifyManagerAccountTests require an existing Prod and Staging ACME account for letsencrypt.org to exist. It also requires a .env.test_accounts file in the directory C:\ProgramData\certify\Tests with values for RESTORE_KEY_PEM, RESTORE_ACCOUNT_URI, and RESTORE_ACCOUNT_EMAIL for an existing letsencrypt.org ACME account 
      RESTORE_KEY_PEM="-----BEGIN EC PRIVATE KEY-----\r\nMHcCAQEEINL5koIn4o+an+EwyDQEd4Ggnxra5j7Oro13M5klKmhaoAoGCCqGSM49\r\nAwEHoUQDQgAEPF7u1CLMe9FIBQo0MVmv7vlvqGOdSERG5nRLkNKTDUgBRxkXGqY+\r\nGbnnzXUb7j4g7VN7CuEy0SpCdFItD+63hQ==\r\n-----END EC PRIVATE KEY-----\r\n"
RESTORE_ACCOUNT_URI=https://acme-staging-v02.api.letsencrypt.org/acme/acct/123456789
RESTORE_ACCOUNT_EMAIL=admin.8c635b@test.com

  • Integration tests exercise multiple components and may interact with ACME services etc. Required elements include:

    • IIS Installed on local machine
      • A non-enabled site in IIS is needed for TestCertifyManagerGetPrimaryWebSitesIncludeStoppedSites() in CertifyManagerServerTypeTests.cs
    • Must set IncludeExternalPlugins to true in C:\ProgramData\certify\appsettings.json and run copy-plugins.bat from certify-internal
    • The debug version of the app must be configured with a contact against staging Let's Encrypt servers
    • Completing HTTP challenges requires that the machine can respond to port 80 requests from the internet (such as the Let's Encrypt staging server checks)
    • DNS API Credentials test and DNS Challenges require the respective DNS credentials by configured as saved credentials in the UI (see config below)
    • Some tests will require at least one existing certificate in the (personal) computer certificate store

    Integration test config settings can be stored at C:\Temp\TestConfigSettings.json

    Example Config

     {
     "HttpPort":"80",
     "TestCredentialsKey_Route53": "a04878d7-6c32-4f17-9f8e-c332669bd9fb",
     "TestCredentialsKey_Cloudflare": "c8760c11-b5c1-432415a-9add-defa534",
     "TestCredentialsKey_Azure": "5252-7255-4ff0-523524-737393",
     "AWS_ZoneId": "ABCD123456",
     "AWS_TestDomain": "mytestdomain.co.uk",
     "Azure_ZoneId": "mytestdomain.io",
     "Azure_TestDomain": "myothertest.io",
     "Cloudflare_ZoneId": "5265262gdd562s4x6xd64zxczxcv",
     "Cloudflare_TestDomain": "anothertest.com"
 }

  • In addition, the test domain for some tests can be set using the CERTIFY_TESTDOMAIN environment variable.