/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2013, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.as.controller.access.rbac;

import static org.jboss.as.controller.PathAddress.pathAddress;
import static org.jboss.as.controller.PathElement.pathElement;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ADD;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.NAME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.READ_ATTRIBUTE_OPERATION;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.RESULT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.VALUE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.WRITE_ATTRIBUTE_OPERATION;
import static org.junit.Assert.assertEquals;

import org.jboss.as.controller.AbstractAddStepHandler;
import org.jboss.as.controller.AbstractRemoveStepHandler;
import org.jboss.as.controller.AttributeDefinition;
import org.jboss.as.controller.ManagementModel;
import org.jboss.as.controller.ModelOnlyWriteAttributeHandler;
import org.jboss.as.controller.ProcessType;
import org.jboss.as.controller.SimpleAttributeDefinitionBuilder;
import org.jboss.as.controller.SimpleResourceDefinition;
import org.jboss.as.controller.access.constraint.ApplicationTypeConfig;
import org.jboss.as.controller.access.constraint.SensitivityClassification;
import org.jboss.as.controller.access.management.AccessConstraintDefinition;
import org.jboss.as.controller.access.management.ApplicationTypeAccessConstraintDefinition;
import org.jboss.as.controller.access.management.SensitiveTargetAccessConstraintDefinition;
import org.jboss.as.controller.descriptions.NonResolvingResourceDescriptionResolver;
import org.jboss.as.controller.operations.common.Util;
import org.jboss.as.controller.operations.global.GlobalNotifications;
import org.jboss.as.controller.operations.global.GlobalOperationHandlers;
import org.jboss.as.controller.registry.ManagementResourceRegistration;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.ModelType;
import org.junit.Before;
import org.junit.Test;

/**
 * @author Ladislav Thon <lthon@redhat.com>
 */
public class WriteAttributeTestCase extends AbstractRbacTestBase {
    public static final String UNCONSTRAINED_RESOURCE = "unconstrained-resource";
    public static final String SENSITIVE_CONSTRAINED_RESOURCE = "sensitive-constrained-resource";
    public static final String APPLICATION_CONSTRAINED_RESOURCE = "application-constrained-resource";

    public static final String UNCONSTRAINED_READWRITE_ATTRIBUTE = "unconstrained-readwrite-attribute";
    public static final String OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE = "old value of unconstrained-readwrite-attribute";
    public static final String NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE = "new value of unconstrained-readwrite-attribute";

    public static final String SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE = "sensitive-constrained-readwrite-attribute";
    public static final String OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE = "old value of sensitive-constrained-readwrite-attribute";
    public static final String NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE = "new value of sensitive-constrained-readwrite-attribute";

    public static final String APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE = "application-constrained-readwrite-attribute";
    public static final String OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE = "old value of application-constrained-readwrite-attribute";
    public static final String NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE = "new value of application-constrained-readwrite-attribute";

    public static final String FOO = "foo";

    @Before
    public void setUp() {
        ModelNode operation = Util.createOperation(ADD, pathAddress(UNCONSTRAINED_RESOURCE, FOO));
        executeWithRoles(operation, StandardRole.SUPERUSER);

        operation = Util.createOperation(ADD, pathAddress(SENSITIVE_CONSTRAINED_RESOURCE, FOO));
        executeWithRoles(operation, StandardRole.SUPERUSER);

        operation = Util.createOperation(ADD, pathAddress(APPLICATION_CONSTRAINED_RESOURCE, FOO));
        executeWithRoles(operation, StandardRole.SUPERUSER);
    }

    @Test
    public void testMonitor() {
        test(false, false, StandardRole.MONITOR);
    }

    @Test
    public void testOperator() {
        test(false, false, StandardRole.OPERATOR);
    }

    @Test
    public void testMaintainer() {
        test(true, false, StandardRole.MAINTAINER);
    }

    @Test
    public void testDeployer() {
        // would be hard to reuse test(..., StandardRole.DEPLOYER)

        StandardRole role = StandardRole.DEPLOYER;

        ResultExpectation readExpectation = ResultExpectation.PERMITTED;
        ResultExpectation writeExpectation = ResultExpectation.DENIED;

        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, role);

        readExpectation = ResultExpectation.DENIED;
        writeExpectation = ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, role);

        readExpectation = ResultExpectation.NO_ACCESS;
        writeExpectation = ResultExpectation.NO_ACCESS;
        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, role);
        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, role);
        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, role);

        readExpectation = ResultExpectation.PERMITTED;
        writeExpectation = ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, role);
        writeExpectation = ResultExpectation.PERMITTED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, role);

        readExpectation = ResultExpectation.DENIED;
        writeExpectation = ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, role);

        readExpectation = ResultExpectation.PERMITTED;
        writeExpectation = ResultExpectation.PERMITTED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, role);
    }

    @Test
    public void testAdministrator() {
        test(true, true, StandardRole.ADMINISTRATOR);
    }

    @Test
    public void testAuditor() {
        test(false, true, StandardRole.AUDITOR);
    }

    @Test
    public void testSuperuser() {
        test(true, true, StandardRole.SUPERUSER);
    }

    @Test
    public void testMonitorOperator() {
        test(false, false, StandardRole.MONITOR, StandardRole.OPERATOR);
    }

    @Test
    public void testMonitorMaintainer() {
        test(true, false, StandardRole.MONITOR, StandardRole.MAINTAINER);
    }

    @Test
    public void testMonitorAdministrator() {
        test(true, true, StandardRole.MONITOR, StandardRole.ADMINISTRATOR);
    }

    @Test
    public void testAdministratorAuditor() {
        test(true, true, StandardRole.ADMINISTRATOR, StandardRole.AUDITOR);
    }

    @Test
    public void testMonitorAuditor() {
        test(false, true, StandardRole.MONITOR, StandardRole.AUDITOR);
    }

    private void testOperation(ResultExpectation readResultExpectation, ResultExpectation writeResultExpectation,
                               String resourceName, String attributeName, String oldAttributeValue,
                               String newAttributeValue, StandardRole... roles) {
        ModelNode operation = Util.createOperation(READ_ATTRIBUTE_OPERATION, pathAddress(resourceName, FOO));
        operation.get(NAME).set(attributeName);
        ModelNode result = executeWithRoles(operation, roles);
        assertOperationResult(result, readResultExpectation);
        if (readResultExpectation == ResultExpectation.PERMITTED) {
            assertEquals(oldAttributeValue, result.get(RESULT).asString());
        }

        operation = Util.createOperation(WRITE_ATTRIBUTE_OPERATION, pathAddress(resourceName, FOO));
        operation.get(NAME).set(attributeName);
        operation.get(VALUE).set(newAttributeValue);
        result = executeWithRoles(operation, roles);
        assertOperationResult(result, writeResultExpectation);

        if (writeResultExpectation != ResultExpectation.PERMITTED) {
            return;
        }

        operation = Util.createOperation(READ_ATTRIBUTE_OPERATION, pathAddress(resourceName, FOO));
        operation.get(NAME).set(attributeName);
        result = executeWithRoles(operation, roles);
        assertOperationResult(result, readResultExpectation);
        if (readResultExpectation == ResultExpectation.PERMITTED) {
            assertEquals(newAttributeValue, result.get(RESULT).asString());
        }
    }

    private void test(boolean canWrite, boolean canAccessSensitive, StandardRole... roles) {
        ResultExpectation readExpectation = ResultExpectation.PERMITTED;
        ResultExpectation writeExpectation = canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = canAccessSensitive ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        writeExpectation = canAccessSensitive && canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = ResultExpectation.PERMITTED;
        writeExpectation = canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, UNCONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = canAccessSensitive ? ResultExpectation.PERMITTED : ResultExpectation.NO_ACCESS;
        writeExpectation = canAccessSensitive && canWrite ? ResultExpectation.PERMITTED : ResultExpectation.NO_ACCESS;
        if (canAccessSensitive && !canWrite) {
            writeExpectation = ResultExpectation.DENIED;
        }

        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, roles);
        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, roles);
        testOperation(readExpectation, writeExpectation, SENSITIVE_CONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = ResultExpectation.PERMITTED;
        writeExpectation = canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, UNCONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = canAccessSensitive ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        writeExpectation = canAccessSensitive && canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, roles);

        readExpectation = ResultExpectation.PERMITTED;
        writeExpectation = canWrite ? ResultExpectation.PERMITTED : ResultExpectation.DENIED;
        testOperation(readExpectation, writeExpectation, APPLICATION_CONSTRAINED_RESOURCE, APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE,
                NEW_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, roles);
    }

    // model definition

    private static final SensitivityClassification MY_SENSITIVITY
            = new SensitivityClassification("test", "my-sensitivity", true, true, true);
    private static final AccessConstraintDefinition MY_SENSITIVE_CONSTRAINT
            = new SensitiveTargetAccessConstraintDefinition(MY_SENSITIVITY);

    private static final ApplicationTypeConfig MY_APPLICATION_TYPE
            = new ApplicationTypeConfig("test", "my-application-type", true);
    private static final AccessConstraintDefinition MY_APPLICATION_CONSTRAINT
            = new ApplicationTypeAccessConstraintDefinition(MY_APPLICATION_TYPE);

    @Override
    protected void initModel(ManagementModel managementModel) {
        ManagementResourceRegistration registration = managementModel.getRootResourceRegistration();
        GlobalOperationHandlers.registerGlobalOperations(registration, ProcessType.EMBEDDED_SERVER);

        GlobalNotifications.registerGlobalNotifications(registration, ProcessType.EMBEDDED_SERVER);

        registration.registerSubModel(new TestResourceDefinition(UNCONSTRAINED_RESOURCE));
        registration.registerSubModel(new TestResourceDefinition(SENSITIVE_CONSTRAINED_RESOURCE,
                MY_SENSITIVE_CONSTRAINT));
        registration.registerSubModel(new TestResourceDefinition(APPLICATION_CONSTRAINED_RESOURCE,
                MY_APPLICATION_CONSTRAINT));
    }

    private static final class TestResourceDefinition extends SimpleResourceDefinition {

        TestResourceDefinition(String path, AccessConstraintDefinition... constraintDefinitions) {
            super(new Parameters(pathElement(path), NonResolvingResourceDescriptionResolver.INSTANCE)
                    .setAddHandler(new AbstractAddStepHandler() {})
                    .setRemoveHandler(new AbstractRemoveStepHandler() {})
                    .setAccessConstraints(constraintDefinitions));
        }

        @Override
        public void registerAttributes(ManagementResourceRegistration resourceRegistration) {
            super.registerAttributes(resourceRegistration);

            AttributeDefinition attributeDefinition = SimpleAttributeDefinitionBuilder
                    .create(UNCONSTRAINED_READWRITE_ATTRIBUTE, ModelType.STRING, true)
                    .setDefaultValue(new ModelNode(OLD_VALUE_OF_UNCONSTRAINED_READWRITE_ATTRIBUTE))
                    .build();
            resourceRegistration.registerReadWriteAttribute(attributeDefinition, null,
                    new ModelOnlyWriteAttributeHandler(attributeDefinition));

            attributeDefinition = SimpleAttributeDefinitionBuilder
                    .create(SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE, ModelType.STRING, true)
                    .setDefaultValue(new ModelNode(OLD_VALUE_OF_SENSITIVE_CONSTRAINED_READWRITE_ATTRIBUTE))
                    .setAccessConstraints(MY_SENSITIVE_CONSTRAINT)
                    .build();
            resourceRegistration.registerReadWriteAttribute(attributeDefinition, null,
                    new ModelOnlyWriteAttributeHandler(attributeDefinition));

            attributeDefinition = SimpleAttributeDefinitionBuilder
                    .create(APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE, ModelType.STRING, true)
                    .setDefaultValue(new ModelNode(OLD_VALUE_OF_APPLICATION_CONSTRAINED_READWRITE_ATTRIBUTE))
                    .setAccessConstraints(MY_APPLICATION_CONSTRAINT)
                    .build();
            resourceRegistration.registerReadWriteAttribute(attributeDefinition, null,
                    new ModelOnlyWriteAttributeHandler(attributeDefinition));
        }
    }
}
