poi-ooxml/src/test/java/org/apache/poi/xssf/TestSheetProtection.java

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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 org.apache.poi.xssf;

import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.io.IOException;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

class TestSheetProtection {
	private XSSFWorkbook workbook;
	private XSSFSheet sheet;

	@BeforeEach
	void setUp() {
		workbook = XSSFTestDataSamples.openSampleWorkbook("sheetProtection_not_protected.xlsx");
		sheet = workbook.getSheetAt(0);
	}

	@AfterEach
	void tearDown() throws IOException {
		workbook.close();
	}

	@Test
	void testShouldReadWorkbookProtection() throws IOException {
		assertFalse(sheet.isAutoFilterLocked());
		assertFalse(sheet.isDeleteColumnsLocked());
		assertFalse(sheet.isDeleteRowsLocked());
		assertFalse(sheet.isFormatCellsLocked());
		assertFalse(sheet.isFormatColumnsLocked());
		assertFalse(sheet.isFormatRowsLocked());
		assertFalse(sheet.isInsertColumnsLocked());
		assertFalse(sheet.isInsertHyperlinksLocked());
		assertFalse(sheet.isInsertRowsLocked());
		assertFalse(sheet.isPivotTablesLocked());
		assertFalse(sheet.isSortLocked());
		assertFalse(sheet.isObjectsLocked());
		assertFalse(sheet.isScenariosLocked());
		assertFalse(sheet.isSelectLockedCellsLocked());
		assertFalse(sheet.isSelectUnlockedCellsLocked());
		assertFalse(sheet.isSheetLocked());

		try (XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("sheetProtection_allLocked.xlsx")) {
			sheet = workbook.getSheetAt(0);

			assertTrue(sheet.isAutoFilterLocked());
			assertTrue(sheet.isDeleteColumnsLocked());
			assertTrue(sheet.isDeleteRowsLocked());
			assertTrue(sheet.isFormatCellsLocked());
			assertTrue(sheet.isFormatColumnsLocked());
			assertTrue(sheet.isFormatRowsLocked());
			assertTrue(sheet.isInsertColumnsLocked());
			assertTrue(sheet.isInsertHyperlinksLocked());
			assertTrue(sheet.isInsertRowsLocked());
			assertTrue(sheet.isPivotTablesLocked());
			assertTrue(sheet.isSortLocked());
			assertTrue(sheet.isObjectsLocked());
			assertTrue(sheet.isScenariosLocked());
			assertTrue(sheet.isSelectLockedCellsLocked());
			assertTrue(sheet.isSelectUnlockedCellsLocked());
			assertTrue(sheet.isSheetLocked());
		}
	}

	@Test
	void testWriteAutoFilter() {
		assertFalse(sheet.isAutoFilterLocked());
		sheet.lockAutoFilter(true);
		assertFalse(sheet.isAutoFilterLocked());
		sheet.enableLocking();
		assertTrue(sheet.isAutoFilterLocked());
		sheet.lockAutoFilter(false);
		assertFalse(sheet.isAutoFilterLocked());
	}

	@Test
	void testWriteDeleteColumns() {
		assertFalse(sheet.isDeleteColumnsLocked());
		sheet.lockDeleteColumns(true);
		assertFalse(sheet.isDeleteColumnsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isDeleteColumnsLocked());
		sheet.lockDeleteColumns(false);
		assertFalse(sheet.isDeleteColumnsLocked());
	}

	@Test
	void testWriteDeleteRows() {
		assertFalse(sheet.isDeleteRowsLocked());
		sheet.lockDeleteRows(true);
		assertFalse(sheet.isDeleteRowsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isDeleteRowsLocked());
        sheet.lockDeleteRows(false);
        assertFalse(sheet.isDeleteRowsLocked());
	}

	@Test
	void testWriteFormatCells() {
		assertFalse(sheet.isFormatCellsLocked());
		sheet.lockFormatCells(true);
		assertFalse(sheet.isFormatCellsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isFormatCellsLocked());
        sheet.lockFormatCells(false);
        assertFalse(sheet.isFormatCellsLocked());
	}

	@Test
	void testWriteFormatColumns() {
		assertFalse(sheet.isFormatColumnsLocked());
		sheet.lockFormatColumns(true);
		assertFalse(sheet.isFormatColumnsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isFormatColumnsLocked());
        sheet.lockFormatColumns(false);
        assertFalse(sheet.isFormatColumnsLocked());
	}

	@Test
	void testWriteFormatRows() {
		assertFalse(sheet.isFormatRowsLocked());
		sheet.lockFormatRows(true);
		assertFalse(sheet.isFormatRowsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isFormatRowsLocked());
        sheet.lockFormatRows(false);
        assertFalse(sheet.isFormatRowsLocked());
	}

	@Test
	void testWriteInsertColumns() {
		assertFalse(sheet.isInsertColumnsLocked());
		sheet.lockInsertColumns(true);
		assertFalse(sheet.isInsertColumnsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isInsertColumnsLocked());
        sheet.lockInsertColumns(false);
        assertFalse(sheet.isInsertColumnsLocked());
	}

	@Test
	void testWriteInsertHyperlinks() {
		assertFalse(sheet.isInsertHyperlinksLocked());
		sheet.lockInsertHyperlinks(true);
		assertFalse(sheet.isInsertHyperlinksLocked());
		sheet.enableLocking();
		assertTrue(sheet.isInsertHyperlinksLocked());
        sheet.lockInsertHyperlinks(false);
        assertFalse(sheet.isInsertHyperlinksLocked());
	}

	@Test
	void testWriteInsertRows() {
		assertFalse(sheet.isInsertRowsLocked());
		sheet.lockInsertRows(true);
		assertFalse(sheet.isInsertRowsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isInsertRowsLocked());
        sheet.lockInsertRows(false);
        assertFalse(sheet.isInsertRowsLocked());
	}

	@Test
	void testWritePivotTables() {
		assertFalse(sheet.isPivotTablesLocked());
		sheet.lockPivotTables(true);
		assertFalse(sheet.isPivotTablesLocked());
		sheet.enableLocking();
		assertTrue(sheet.isPivotTablesLocked());
        sheet.lockPivotTables(false);
        assertFalse(sheet.isPivotTablesLocked());
	}

	@Test
	void testWriteSort() {
		assertFalse(sheet.isSortLocked());
		sheet.lockSort(true);
		assertFalse(sheet.isSortLocked());
		sheet.enableLocking();
		assertTrue(sheet.isSortLocked());
        sheet.lockSort(false);
        assertFalse(sheet.isSortLocked());
	}

	@Test
	void testWriteObjects() {
		assertFalse(sheet.isObjectsLocked());
		sheet.lockObjects(true);
		assertFalse(sheet.isObjectsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isObjectsLocked());
        sheet.lockObjects(false);
        assertFalse(sheet.isObjectsLocked());
	}

	@Test
	void testWriteScenarios() {
		assertFalse(sheet.isScenariosLocked());
		sheet.lockScenarios(true);
		assertFalse(sheet.isScenariosLocked());
		sheet.enableLocking();
		assertTrue(sheet.isScenariosLocked());
        sheet.lockScenarios(false);
        assertFalse(sheet.isScenariosLocked());
	}

	@Test
	void testWriteSelectLockedCells() {
		assertFalse(sheet.isSelectLockedCellsLocked());
		sheet.lockSelectLockedCells(true);
		assertFalse(sheet.isSelectLockedCellsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isSelectLockedCellsLocked());
        sheet.lockSelectLockedCells(false);
        assertFalse(sheet.isSelectLockedCellsLocked());
	}

	@Test
	void testWriteSelectUnlockedCells() {
		assertFalse(sheet.isSelectUnlockedCellsLocked());
		sheet.lockSelectUnlockedCells(true);
		assertFalse(sheet.isSelectUnlockedCellsLocked());
		sheet.enableLocking();
		assertTrue(sheet.isSelectUnlockedCellsLocked());
        sheet.lockSelectUnlockedCells(false);
        assertFalse(sheet.isSelectUnlockedCellsLocked());
	}

	@Test
	void testWriteSelectEnableLocking() throws IOException {
		try (XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("sheetProtection_allLocked.xlsx")) {
			sheet = workbook.getSheetAt(0);

			assertTrue(sheet.isAutoFilterLocked());
			assertTrue(sheet.isDeleteColumnsLocked());
			assertTrue(sheet.isDeleteRowsLocked());
			assertTrue(sheet.isFormatCellsLocked());
			assertTrue(sheet.isFormatColumnsLocked());
			assertTrue(sheet.isFormatRowsLocked());
			assertTrue(sheet.isInsertColumnsLocked());
			assertTrue(sheet.isInsertHyperlinksLocked());
			assertTrue(sheet.isInsertRowsLocked());
			assertTrue(sheet.isPivotTablesLocked());
			assertTrue(sheet.isSortLocked());
			assertTrue(sheet.isObjectsLocked());
			assertTrue(sheet.isScenariosLocked());
			assertTrue(sheet.isSelectLockedCellsLocked());
			assertTrue(sheet.isSelectUnlockedCellsLocked());
			assertTrue(sheet.isSheetLocked());

			sheet.disableLocking();

			assertFalse(sheet.isAutoFilterLocked());
			assertFalse(sheet.isDeleteColumnsLocked());
			assertFalse(sheet.isDeleteRowsLocked());
			assertFalse(sheet.isFormatCellsLocked());
			assertFalse(sheet.isFormatColumnsLocked());
			assertFalse(sheet.isFormatRowsLocked());
			assertFalse(sheet.isInsertColumnsLocked());
			assertFalse(sheet.isInsertHyperlinksLocked());
			assertFalse(sheet.isInsertRowsLocked());
			assertFalse(sheet.isPivotTablesLocked());
			assertFalse(sheet.isSortLocked());
			assertFalse(sheet.isObjectsLocked());
			assertFalse(sheet.isScenariosLocked());
			assertFalse(sheet.isSelectLockedCellsLocked());
			assertFalse(sheet.isSelectUnlockedCellsLocked());
			assertFalse(sheet.isSheetLocked());
		}
	}
}