com.trivago.cluecumber.engine.rendering.pages.renderering.CustomCssRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cluecumber-engine Show documentation
The Cluecumber reporting engine.
The newest version!
/*
 * Copyright 2023 trivago N.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.trivago.cluecumber.engine.rendering.pages.renderering;

import com.trivago.cluecumber.engine.exceptions.CluecumberException;
import com.trivago.cluecumber.engine.properties.PropertyManager;
import freemarker.template.Template;
import freemarker.template.TemplateException;

import javax.inject.Inject;
import javax.inject.Singleton;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;

/**
 * The renderer for the custom CSS styles.
 */
@Singleton
public class CustomCssRenderer {

    private final PropertyManager propertyManager;

    /**
     * Constructor for dependency injection.
     *
     * @param propertyManager The {@link PropertyManager} instance.
     */
    @Inject
    public CustomCssRenderer(final PropertyManager propertyManager) {
        this.propertyManager = propertyManager;
    }

    /**
     * Return the completely rendered custom css content.
     *
     * @param template The Freemarker template.
     * @return The fully rendered content.
     * @throws CluecumberException In case of a rendering error.
     */
    public String getRenderedCustomCssContent(final Template template) throws CluecumberException {
        Writer stringWriter = new StringWriter();

        CustomStatusColors customStatusColors = new CustomStatusColors(
                propertyManager.getCustomStatusColorPassed(),
                propertyManager.getCustomStatusColorFailed(),
                propertyManager.getCustomStatusColorSkipped()
        );

        try {
            template.process(customStatusColors, stringWriter);
        } catch (TemplateException | IOException e) {
            throw new CluecumberException("Could not render custom css content: " + e.getMessage());
        }
        return stringWriter.toString();
    }

    /**
     * Class for custom status colors.
     */
    @SuppressWarnings("unused")
    public static class CustomStatusColors {

        private final String passedColor;
        private final String failedColor;
        private final String skippedColor;

        CustomStatusColors(String passedColor, String failedColor, String skippedColor) {
            this.passedColor = passedColor;
            this.failedColor = failedColor;
            this.skippedColor = skippedColor;
        }

        /**
         * Get the passed color.
         * @return The hex color string.
         */
        public String getPassedColor() {
            return passedColor;
        }

        /**
         * Get the failed color.
         * @return The hex color string.
         */
        public String getFailedColor() {
            return failedColor;
        }

        /**
         * Get the skipped color.
         * @return The hex color string.
         */
        public String getSkippedColor() {
            return skippedColor;
        }
    }
}