Environment variables on test level that are also managed by rule chains. #72

Activity

1. jetersen commented on Mar 21, 2019

   

   jetersen

   on Mar 21, 2019

   Last edited by jetersen

   Author

   More actions

   For ease I will copy some of the code here:

   Annotation usage

   Converting a relative file path to an absolute file path so it can be used by the code that gets tested. ConfiguredWithCode annotation needs the ENV variables, therefore, we have a rule chain setup

       @Test
       @ConfiguredWithCode("SeedJobTest_withSecurityConfig.yml")
       @Envs(
           @Env(name = "SEED_JOB_FOLDER_FILE_PATH", value = ".")
       )
       public void configure_seed_job_with_security_config() throws Exception {
           final Jenkins jenkins = Jenkins.get();
   
            final GlobalJobDslSecurityConfiguration dslSecurity = GlobalConfiguration.all()
               .get(GlobalJobDslSecurityConfiguration.class);
           assertNotNull(dslSecurity);
           assertThat("ScriptSecurity", dslSecurity.isUseScriptSecurity(), is(false));
   
            FreeStyleProject seedJobWithSecurityConfig = (FreeStyleProject) jenkins.getItem("seedJobWithSecurityConfig");
           assertNotNull(seedJobWithSecurityConfig);
   
            assertTrue(seedJobWithSecurityConfig.isInQueue());
           j.buildAndAssertSuccess(seedJobWithSecurityConfig);
       }

   Rule chain

       private JenkinsRule j;
   
       @Rule
       public RuleChain rc = RuleChain.outerRule(new EnvVarsRule()
               .set("SEED_JOB_PATH", "./src/test/resources/io/jenkins/plugins/casc/testJob2.groovy")
               .set("REPO_URL", "git://github.com/jenkinsci/configuration-as-code-plugin.git"))
               .around(j = new JenkinsConfiguredWithCodeRule());

   With EnvsFromFIle we can read in secrets generated by vault 😅

       @Test
       @ConfiguredWithCode("vault.yml")
       @EnvsFromFile(VAULT_APPROLE_FILE)
       @Envs({
           @Env(name = "CASC_VAULT_PATHS", value = VAULT_PATH_KV2_1 + "," + VAULT_PATH_KV2_2),
           @Env(name = "CASC_VAULT_ENGINE_VERSION", value = "2")
       })
       public void kv2WithApprole() throws ConfiguratorException {
           assertThat(SecretSourceResolver.resolve(context, "${key1}"), equalTo("123"));
       }

   The annotation work:

   public class EnvVarsRule extends EnvironmentVariables {
   
       private Class clazz;
   
       private void setValue(Env env) {
           String value = env.value();
           if (env.name().endsWith("FILE_PATH")) {
               value = new File(clazz.getResource(value).getPath()).getAbsolutePath();
           }
           set(env.name(), value);
       }
   
       @Override
       public Statement apply(Statement base, Description description) {
           EnvsFromFile configuredWithEnvsFromFile = description.getAnnotation(EnvsFromFile.class);
           clazz = description.getTestClass();
           if (Objects.nonNull(configuredWithEnvsFromFile)) {
   
               final String[] resource = configuredWithEnvsFromFile.value();
   
               final List envFiles = Arrays.stream(resource)
                   .map(s -> Paths.get(System.getProperty("java.io.tmpdir"), s).toString())
                   .collect(Collectors.toList());
   
               Properties properties = new Properties();
               for (String file : envFiles) {
                   try (FileInputStream inputStream = new FileInputStream(file)) {
                       properties.load(inputStream);
                   } catch (IOException e) {
                       e.printStackTrace();
                   }
               }
               properties.forEach((key, value) -> set(String.valueOf(key), String.valueOf(value)));
           }
           Envs configuredWithEnvs = description.getAnnotation(Envs.class);
           if (Objects.nonNull(configuredWithEnvs)) {
               List envs = Arrays.asList(configuredWithEnvs.value());
               envs.forEach(this::setValue);
           }
           return super.apply(base, description);
       }
   }