001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.maven.scm.tck.command.changelog; 020 021import java.util.Collections; 022import java.util.Date; 023import java.util.List; 024 025import org.apache.maven.scm.ChangeSet; 026import org.apache.maven.scm.CommandParameter; 027import org.apache.maven.scm.CommandParameters; 028import org.apache.maven.scm.ScmBranch; 029import org.apache.maven.scm.ScmFileSet; 030import org.apache.maven.scm.ScmTagParameters; 031import org.apache.maven.scm.ScmTckTestCase; 032import org.apache.maven.scm.ScmTestCase; 033import org.apache.maven.scm.command.changelog.ChangeLogScmRequest; 034import org.apache.maven.scm.command.changelog.ChangeLogScmResult; 035import org.apache.maven.scm.command.checkin.CheckInScmResult; 036import org.apache.maven.scm.command.tag.TagScmResult; 037import org.apache.maven.scm.provider.ScmProvider; 038import org.junit.Test; 039 040import static org.junit.Assert.assertEquals; 041import static org.junit.Assert.assertTrue; 042 043/** 044 * Test Changlog command. <br> 045 * 1. Get initial log <br> 046 * 2. Add one revision <br> 047 * 3. Get the two logs <br> 048 * 4. Get the last log based on date <br> 049 * 5. Test last log for date and comment <br> 050 * 051 * @author <a href="mailto:torbjorn@smorgrav.org">Torbj�rn Eikli Sm�rgrav</a> 052 */ 053public abstract class ChangeLogCommandTckTest extends ScmTckTestCase { 054 private static final String COMMIT_MSG = "Second changelog"; 055 private static final String COMMIT_TAG = "v3.14"; 056 057 /** 058 * In some SCMs (Hg) adding a tag creates an extra commit which offsets the expectations. 059 * 060 * @return if an extra commit will be present for a tag 061 */ 062 public boolean isTagAnExtraCommit() { 063 return false; 064 } 065 066 @Test 067 public void testChangeLogCommand() throws Exception { 068 Thread.sleep(1000); 069 ScmProvider provider = getScmManager().getProviderByRepository(getScmRepository()); 070 ScmFileSet fileSet = new ScmFileSet(getWorkingCopy()); 071 072 ChangeLogScmResult firstResult = 073 provider.changeLog(getScmRepository(), fileSet, null, null, 0, (ScmBranch) null, null); 074 assertResultIsSuccess(firstResult); 075 076 // for svn and git the repo get recreated for each test and therefore initial changelog size is 1 077 int firstLogSize = firstResult.getChangeLog().getChangeSets().size(); 078 assertTrue("Unexpected initial log size", firstLogSize >= 1); 079 080 // Make a timestamp that we know are after initial revision but before the second 081 Date timeBeforeSecond = new Date(); // Current time 082 083 // pause a couple seconds... [SCM-244] 084 Thread.sleep(2000); 085 086 // Make a change to the readme.txt and commit the change 087 this.edit(getWorkingCopy(), "readme.txt", null, getScmRepository()); 088 ScmTestCase.makeFile(getWorkingCopy(), "/readme.txt", "changed readme.txt"); 089 CommandParameters commandParameters = new CommandParameters(); 090 commandParameters.setString(CommandParameter.MESSAGE, COMMIT_MSG); 091 CheckInScmResult checkInResult = provider.checkIn(getScmRepository(), fileSet, commandParameters); 092 assertTrue("Unable to checkin changes to the repository", checkInResult.isSuccess()); 093 094 ScmTagParameters scmTagParameters = new ScmTagParameters(); 095 TagScmResult tagResult = provider.tag(getScmRepository(), fileSet, COMMIT_TAG, scmTagParameters); 096 assertResultIsSuccess(tagResult); 097 098 ChangeLogScmRequest changeLogScmRequest = new ChangeLogScmRequest(getScmRepository(), fileSet); 099 ChangeLogScmResult secondResult = provider.changeLog(changeLogScmRequest); 100 assertResultIsSuccess(secondResult); 101 102 List<ChangeSet> changeSets = secondResult.getChangeLog().getChangeSets(); 103 104 int expectedChangeSets = firstLogSize + 1; 105 boolean lastCommitIsCausedByTagging = false; 106 int lastCodeCommitIndex = 0; 107 108 if (isTagAnExtraCommit()) { 109 // This is for example Mercurial which creates an extra commit after tagging. 110 lastCommitIsCausedByTagging = true; 111 expectedChangeSets += 1; 112 lastCodeCommitIndex = 1; 113 } 114 115 assertEquals(expectedChangeSets, changeSets.size()); 116 117 // Check if the tag has been retrieved again 118 ChangeSet changeSetWithTag = changeSets.get(lastCodeCommitIndex); 119 assertEquals(Collections.singletonList(COMMIT_TAG), changeSetWithTag.getTags()); 120 121 // Now only retrieve the changelog after timeBeforeSecondChangeLog 122 Date currentTime = new Date(); 123 changeLogScmRequest = new ChangeLogScmRequest(getScmRepository(), fileSet); 124 changeLogScmRequest.setStartDate(timeBeforeSecond); 125 changeLogScmRequest.setEndDate(currentTime); 126 changeLogScmRequest.setScmBranch(new ScmBranch("")); 127 ChangeLogScmResult thirdResult = provider.changeLog(changeLogScmRequest); 128 129 // Thorough assert of the last result 130 assertResultIsSuccess(thirdResult); 131 132 List<ChangeSet> thirdChangeSets = thirdResult.getChangeLog().getChangeSets(); 133 assertEquals(lastCommitIsCausedByTagging ? 2 : 1, thirdChangeSets.size()); 134 ChangeSet changeset = thirdChangeSets.get(lastCodeCommitIndex); 135 assertTrue(changeset.getDate().after(timeBeforeSecond)); 136 assertTrue(changeset.getComment().startsWith(COMMIT_MSG)); 137 } 138}