gov.nih.nci.firebird.selenium2.tests.protocol.registration.HumanResearchCertificateTabTest.java Source code

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.selenium2.tests.protocol.registration.HumanResearchCertificateTabTest.java

Source

/**
 * The software subject to this notice and license includes both human readable
 * source code form and machine readable, binary, object code form. The NCI OCR
 * Software was developed in conjunction with the National Cancer Institute
 * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent
 * government employees are authors, any rights in such works shall be subject
 * to Title 17 of the United States Code, section 105.
 *
 * This NCI OCR Software License (the License) is between NCI and You. You (or
 * Your) shall mean a person or an entity, and all other entities that control,
 * are controlled by, or are under common control with the entity. Control for
 * purposes of this definition means (i) the direct or indirect power to cause
 * the direction or management of such entity, whether by contract or otherwise,
 * or (ii) ownership of fifty percent (50%) or more of the outstanding shares,
 * or (iii) beneficial ownership of such entity.
 *
 * This License is granted provided that You agree to the conditions described
 * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
 * no-charge, irrevocable, transferable and royalty-free right and license in
 * its rights in the NCI OCR Software to (i) use, install, access, operate,
 * execute, copy, modify, translate, market, publicly display, publicly perform,
 * and prepare derivative works of the NCI OCR Software; (ii) distribute and
 * have distributed to and by third parties the NCI OCR Software and any
 * modifications and derivative works thereof; and (iii) sublicense the
 * foregoing rights set out in (i) and (ii) to third parties, including the
 * right to license such rights to further third parties. For sake of clarity,
 * and not by way of limitation, NCI shall have no right of accounting or right
 * of payment from You or Your sub-licensees for the rights granted under this
 * License. This License is granted at no charge to You.
 *
 * Your redistributions of the source code for the Software must retain the
 * above copyright notice, this list of conditions and the disclaimer and
 * limitation of liability of Article 6, below. Your redistributions in object
 * code form must reproduce the above copyright notice, this list of conditions
 * and the disclaimer of Article 6 in the documentation and/or other materials
 * provided with the distribution, if any.
 *
 * Your end-user documentation included with the redistribution, if any, must
 * include the following acknowledgment: This product includes software
 * developed by 5AM and the National Cancer Institute. If You do not include
 * such end-user documentation, You shall include this acknowledgment in the
 * Software itself, wherever such third-party acknowledgments normally appear.
 *
 * You may not use the names "The National Cancer Institute", "NCI", or "5AM"
 * to endorse or promote products derived from this Software. This License does
 * not authorize You to use any trademarks, service marks, trade names, logos or
 * product names of either NCI or 5AM, except as required to comply with the
 * terms of this License.
 *
 * For sake of clarity, and not by way of limitation, You may incorporate this
 * Software into Your proprietary programs and into any third party proprietary
 * programs. However, if You incorporate the Software into third party
 * proprietary programs, You agree that You are solely responsible for obtaining
 * any permission from such third parties required to incorporate the Software
 * into such third party proprietary programs and for informing Your
 * sub-licensees, including without limitation Your end-users, of their
 * obligation to secure any required permissions from such third parties before
 * incorporating the Software into such third party proprietary software
 * programs. In the event that You fail to obtain such permissions, You agree
 * to indemnify NCI for any claims against NCI by such third parties, except to
 * the extent prohibited by law, resulting from Your failure to obtain such
 * permissions.
 *
 * For sake of clarity, and not by way of limitation, You may add Your own
 * copyright statement to Your modifications and to the derivative works, and
 * You may provide additional or different license terms and conditions in Your
 * sublicenses of modifications of the Software, or any derivative works of the
 * Software as a whole, provided Your use, reproduction, and distribution of the
 * Work otherwise complies with the conditions stated in this License.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
 * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR
 * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package gov.nih.nci.firebird.selenium2.tests.protocol.registration;

import static org.junit.Assert.*;
import gov.nih.nci.firebird.commons.test.TestFileUtils;
import gov.nih.nci.firebird.data.AbstractProtocolRegistration;
import gov.nih.nci.firebird.data.FormOptionality;
import gov.nih.nci.firebird.data.FormStatus;
import gov.nih.nci.firebird.data.InvestigatorRegistration;
import gov.nih.nci.firebird.data.TrainingCertificate;
import gov.nih.nci.firebird.data.user.FirebirdUser;
import gov.nih.nci.firebird.exception.CredentialAlreadyExistsException;
import gov.nih.nci.firebird.selenium2.framework.AbstractFirebirdWebDriverTest;
import gov.nih.nci.firebird.selenium2.pages.investigator.profile.CredentialsTab;
import gov.nih.nci.firebird.selenium2.pages.investigator.profile.EditTrainingCertificateDialog;
import gov.nih.nci.firebird.selenium2.pages.investigator.profile.TrainingCertificateSection;
import gov.nih.nci.firebird.selenium2.pages.investigator.protocol.registration.BrowseRegistrationsPage;
import gov.nih.nci.firebird.selenium2.pages.investigator.protocol.registration.HumanResearchCertificateTab;
import gov.nih.nci.firebird.selenium2.pages.investigator.protocol.registration.HumanResearchCertificateTab.CertificateListing;
import gov.nih.nci.firebird.selenium2.pages.investigator.protocol.registration.RegistrationOverviewTab;
import gov.nih.nci.firebird.selenium2.pages.investigator.registration.common.InvestigatorRegistrationFormTablesTag.FormListing;
import gov.nih.nci.firebird.test.CredentialFactory;
import gov.nih.nci.firebird.test.LoginAccount;
import gov.nih.nci.firebird.test.LoginAccount.InvestigatorLogin;
import gov.nih.nci.firebird.test.data.DataSet;
import gov.nih.nci.firebird.test.data.DataSetBuilder;

import java.io.File;
import java.io.IOException;
import java.util.Calendar;
import java.util.Date;

import org.apache.commons.lang3.time.DateUtils;
import org.junit.Test;

public class HumanResearchCertificateTabTest extends AbstractFirebirdWebDriverTest {

    private DataSet dataSet;

    @Override
    public void setUp() throws Exception {
        super.setUp();
        DataSetBuilder builder = new DataSetBuilder(getDataLoader(), getGridResources());
        FirebirdUser investigator = builder.createInvestigator().get();
        InvestigatorRegistration primaryRegistration = builder.createRegistration(investigator).get();
        FirebirdUser subinvestigator = builder.createInvestigator().withLogin(InvestigatorLogin.fbciinv2).get();
        builder.createSubinvestigatorRegistration(subinvestigator, primaryRegistration);
        dataSet = builder.build();
        navigateToHumanResearchCertificateTab();
    }

    protected HumanResearchCertificateTab navigateToHumanResearchCertificateTab() {
        BrowseRegistrationsPage browsePage = openHomePage(getLogin()).getInvestigatorMenu()
                .clickProtocolRegistrations();
        RegistrationOverviewTab overviewTab = browsePage.getHelper().getRegistrationListing(getRegistration())
                .clickRegistrationLink();
        return (HumanResearchCertificateTab) overviewTab.getHelper()
                .getFormListing(getRegistration().getHumanResearchCertificateForm()).click();
    }

    protected LoginAccount getLogin() {
        return dataSet.getInvestigatorLogin();
    }

    protected AbstractProtocolRegistration getRegistration() {
        return dataSet.getInvestigatorRegistration();
    }

    @Test
    public void testHumanResourceCertificateTab() throws IOException {
        Calendar effectiveDate = Calendar.getInstance();
        effectiveDate.set(Calendar.YEAR, 1999);
        Calendar expirationDate = Calendar.getInstance();
        File tempFile = TestFileUtils.createTemporaryFile();
        File tempFile2 = TestFileUtils.createTemporaryFile();

        TrainingCertificate certificate = CredentialFactory.getInstance().createCertificate(tempFile,
                getExistingExternalOrganization());
        certificate.setEffectiveDate(effectiveDate.getTime());

        TrainingCertificate certificate2 = CredentialFactory.getInstance().createCertificate(tempFile2,
                getExistingExternalOrganization());
        certificate2.setEffectiveDate(effectiveDate.getTime());
        certificate2.setExpirationDate(null);

        HumanResearchCertificateTab hrcTab = navigateToHumanResearchCertificateTab();

        CertificateListing listing = addAndSelectCertificate(hrcTab, certificate, tempFile);

        certificate.setExpirationDate(expirationDate.getTime());
        listing = updateCertificate(hrcTab, listing, certificate, null);
        assertTrue(listing.isSelected());

        addAndSelectCertificate(hrcTab, certificate2, tempFile2);

        hrcTab = verifyFormStatusOnOverviewTab(hrcTab, FormStatus.COMPLETED);

        assertTrue(hrcTab.getHelper().getListing(certificate).isSelected());
        assertTrue(hrcTab.getHelper().getListing(certificate2).isSelected());

        removeCertificatesFromProfile(hrcTab);

        hrcTab = navigateToHumanResearchCertificateTab();
        hrcTab = verifyFormStatusOnOverviewTab(hrcTab, FormStatus.IN_PROGRESS);

        listing = addAndSelectCertificate(hrcTab, certificate, tempFile);

        hrcTab.getHelper().getListing(certificate).clickDelete().clickDelete();
        assertNull(hrcTab.getHelper().getListing(certificate));
    }

    private CertificateListing addAndSelectCertificate(HumanResearchCertificateTab hrcTab,
            TrainingCertificate certificate, File file) throws IOException {
        EditTrainingCertificateDialog dialog = hrcTab.clickAddCertificate();
        dialog.getHelper().enterTrainingCertificateData(certificate, file, false);
        dialog.clickSave();
        CertificateListing listing = hrcTab.getHelper().getListing(certificate);
        assertFalse(listing.isSelected());
        listing.select();
        return listing;
    }

    private CertificateListing updateCertificate(HumanResearchCertificateTab hrcTab, CertificateListing listing,
            TrainingCertificate certificate, File newFile) throws IOException {
        EditTrainingCertificateDialog dialog = listing.clickEdit();
        dialog.getHelper().enterTrainingCertificateData(certificate, newFile, false);
        dialog.clickSave();
        listing = hrcTab.getHelper().getListing(certificate);
        if (newFile != null) {
            assertEquals(newFile.getName(), listing.getFileName());
        } else {
            assertEquals(certificate.getFile().getName(), listing.getFileName());
        }
        return listing;
    }

    private HumanResearchCertificateTab verifyFormStatusOnOverviewTab(HumanResearchCertificateTab hrcTab,
            FormStatus status) {
        RegistrationOverviewTab overviewTab = hrcTab.getPage().clickOverviewTab();
        FormListing formListing = overviewTab.getHelper()
                .getFormListing(getRegistration().getHumanResearchCertificateForm());

        if (!formListing.getOptionality().equals(FormOptionality.OPTIONAL.getDisplay())) {
            assertEquals(status.getDisplay(), formListing.getFormStatus());
        } else {
            assertEquals(FormStatus.COMPLETED.getDisplay(), formListing.getFormStatus());
        }
        return (HumanResearchCertificateTab) overviewTab.getHelper()
                .getFormListing(getRegistration().getHumanResearchCertificateForm()).click();
    }

    private void removeCertificatesFromProfile(HumanResearchCertificateTab hrcTab) {
        CredentialsTab credentialsTab = hrcTab.getPage().getInvestigatorMenu().clickProfile().getPage()
                .clickCredentialsTab();
        TrainingCertificateSection certificateSection = credentialsTab.getTrainingSection();
        assertEquals(2, certificateSection.getListings().size());
        certificateSection.getListings().get(0).clickDeleteLink().clickDelete();
        assertEquals(1, certificateSection.getListings().size());
        certificateSection.getListings().get(0).clickDeleteLink().clickDelete();
        assertTrue(certificateSection.getListings().isEmpty());
    }

    @Test
    public void testCantSelectExpiredCertificate() throws IOException, CredentialAlreadyExistsException {
        TrainingCertificate expiredCertificate = CredentialFactory.getInstance()
                .createCertificate(TestFileUtils.createTemporaryFile(), getExistingExternalOrganization());
        expiredCertificate.setEffectiveDate(new Date());
        expiredCertificate.setExpirationDate(DateUtils.addMonths(new Date(), -1));

        TrainingCertificate activeCertificate = CredentialFactory.getInstance()
                .createCertificate(TestFileUtils.createTemporaryFile(), getExistingExternalOrganization());
        activeCertificate.setEffectiveDate(new Date());

        getRegistration().getProfile().addCredential(expiredCertificate);
        getRegistration().getProfile().addCredential(activeCertificate);

        dataSet.update(getRegistration().getProfile());

        HumanResearchCertificateTab hrcTab = navigateToHumanResearchCertificateTab();
        assertNotNull(hrcTab.getHelper().getListing(activeCertificate));
        assertNull(hrcTab.getHelper().getListing(expiredCertificate));
    }

    protected DataSet getDataSet() {
        return dataSet;
    }

}