Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move configuration to appearance page #37

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ For example

![System config](docs/system_config.png)

## Configuration as code

```
appearance:
loginTheme:
footer: 'The footer'
head: ''
header: '<h3>Welcome to login theme Jenkins</h3>'
useDefaultTheme: true
```

## Result

Previous config will render login page customization
Expand Down
20 changes: 18 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
<properties>
<changelist>999999-SNAPSHOT</changelist>
<gitHubRepo>jenkinsci/login-theme-plugin</gitHubRepo>
<jenkins.version>2.414.1</jenkins.version>
<jenkins.version>2.421</jenkins.version>
<hpi.compatibleSinceVersion>46</hpi.compatibleSinceVersion>
<configuration-as-code.version>1670.v564dc8b_982d0</configuration-as-code.version>
</properties>
<name>Login Theme Plugin</name>
<description>This plugin allows extending and overriding the default theme used on the login and signup pages since Jenkins 2.128.</description>
Expand All @@ -35,13 +37,27 @@
<dependencies>
<dependency>
<groupId>io.jenkins.tools.bom</groupId>
<artifactId>bom-2.414.x</artifactId>
<artifactId>bom-weekly</artifactId>
<version>2423.vce598171d115</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>io.jenkins</groupId>
<artifactId>configuration-as-code</artifactId>
<version>${configuration-as-code.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.jenkins.configuration-as-code</groupId>
<artifactId>test-harness</artifactId>
<version>${configuration-as-code.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
Expand Down
14 changes: 12 additions & 2 deletions src/main/java/io/jenkins/plugins/logintheme/LoginTheme.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,20 @@

import hudson.Extension;
import jenkins.model.SimplePageDecorator;
import hudson.model.Descriptor;
import jenkins.appearance.AppearanceCategory;
import jenkins.model.GlobalConfigurationCategory;
import net.sf.json.JSONObject;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.StaplerRequest;

import edu.umd.cs.findbugs.annotations.NonNull;

import org.kohsuke.stapler.DataBoundSetter;

import javax.annotation.Nonnull;

@Extension
@Symbol("login-theme-plugin")
@Symbol("loginTheme")
public class LoginTheme extends SimplePageDecorator {

private String head;
Expand All @@ -45,6 +49,12 @@ public class LoginTheme extends SimplePageDecorator {

private boolean useDefaultTheme = true;

@NonNull
@Override
public GlobalConfigurationCategory getCategory() {
return GlobalConfigurationCategory.get(AppearanceCategory.class);
}

public boolean isUseDefaultTheme() {
return useDefaultTheme;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package io.jenkins.plugins.logintheme;

import static org.junit.jupiter.api.Assertions.assertEquals;

import io.jenkins.plugins.casc.misc.ConfiguredWithCode;
import io.jenkins.plugins.casc.misc.JenkinsConfiguredWithCodeRule;
import jenkins.model.Jenkins;
import org.junit.Rule;
import org.junit.Test;

public class ConfigurationAsCodeTest {

@Rule
public JenkinsConfiguredWithCodeRule r = new JenkinsConfiguredWithCodeRule();

@Test
@ConfiguredWithCode("configuration-as-code.yml")
public void should_support_configuration_as_code() throws Exception {
LoginTheme plugin =Jenkins.get().getExtensionList(LoginTheme.class).get(0);
assertEquals(true, plugin.isUseDefaultTheme());
assertEquals("The footer", plugin.getFooter());
assertEquals("The head", plugin.getHead());
assertEquals("The header", plugin.getHeader());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
appearance:
loginTheme:
footer: 'The footer'
head: 'The head'
header: 'The header'
useDefaultTheme: true