summaryrefslogtreecommitdiffstats
path: root/archiva-modules/archiva-base/archiva-common/src
diff options
context:
space:
mode:
authorJoakim Erdfelt <joakime@apache.org>2008-04-15 04:44:17 +0000
committerJoakim Erdfelt <joakime@apache.org>2008-04-15 04:44:17 +0000
commit92362e9ee3b5d2720dd12880ab7a3589f1f84a8d (patch)
tree21a07bd143c42d35cdfa2dd3f14d2fcd070ceb27 /archiva-modules/archiva-base/archiva-common/src
parent11e37d73c422e575be1d6f3fafeaf9658ffd9945 (diff)
downloadarchiva-92362e9ee3b5d2720dd12880ab7a3589f1f84a8d.tar.gz
archiva-92362e9ee3b5d2720dd12880ab7a3589f1f84a8d.zip
Replacing plexus-digest with archiva-checksum
git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@648115 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'archiva-modules/archiva-base/archiva-common/src')
-rw-r--r--archiva-modules/archiva-base/archiva-common/src/main/java/org/apache/maven/archiva/common/utils/Checksums.java240
-rw-r--r--archiva-modules/archiva-base/archiva-common/src/test/java/org/apache/maven/archiva/common/utils/ChecksumsTest.java291
2 files changed, 0 insertions, 531 deletions
diff --git a/archiva-modules/archiva-base/archiva-common/src/main/java/org/apache/maven/archiva/common/utils/Checksums.java b/archiva-modules/archiva-base/archiva-common/src/main/java/org/apache/maven/archiva/common/utils/Checksums.java
deleted file mode 100644
index 8abdfb88e..000000000
--- a/archiva-modules/archiva-base/archiva-common/src/main/java/org/apache/maven/archiva/common/utils/Checksums.java
+++ /dev/null
@@ -1,240 +0,0 @@
-package org.apache.maven.archiva.common.utils;
-
-/*
- * 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.
- */
-
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-
-import org.codehaus.plexus.digest.ChecksumFile;
-import org.codehaus.plexus.digest.Digester;
-import org.codehaus.plexus.digest.DigesterException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Checksums utility component to validate or update checksums on Files.
- *
- * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
- * @version $Id$
- *
- * @plexus.component role="org.apache.maven.archiva.common.utils.Checksums"
- */
-public class Checksums
-{
- private Logger log = LoggerFactory.getLogger(Checksums.class);
-
- /**
- * @plexus.requirement role-hint="sha1"
- */
- private Digester digestSha1;
-
- /**
- * @plexus.requirement role-hint="md5"
- */
- private Digester digestMd5;
-
- /**
- * @plexus.requirement
- */
- private ChecksumFile checksumFile;
-
- public boolean check( File file )
- {
- boolean checksPass = true;
-
- File sha1File = getSha1File( file );
- File md5File = getMd5File( file );
-
- // Both files missing is a failure.
- if ( !sha1File.exists() && !md5File.exists() )
- {
- log.error( "File " + file.getPath() + " has no checksum files (sha1 or md5)." );
- checksPass = false;
- }
-
- if ( sha1File.exists() )
- {
- // Bad sha1 checksum is a failure.
- if ( !validateChecksum( sha1File, "sha1" ) )
- {
- log.warn( "SHA1 is incorrect for " + file.getPath() );
- checksPass = false;
- }
- }
-
- if ( md5File.exists() )
- {
- // Bad md5 checksum is a failure.
- if ( !validateChecksum( md5File, "md5" ) )
- {
- log.warn( "MD5 is incorrect for " + file.getPath() );
- checksPass = false;
- }
- }
-
- // TODO: eek!
- if ( !checksPass )
- {
- // On failure. delete files.
- if ( sha1File.exists() )
- {
- sha1File.delete();
- }
-
- if ( md5File.exists() )
- {
- md5File.delete();
- }
-
- file.delete();
- }
-
- return checksPass;
- }
-
- public boolean update( File file )
- {
- boolean checksPass = true;
-
- File sha1File = getSha1File( file );
- File md5File = getMd5File( file );
-
- if ( !fixChecksum( file, sha1File, digestSha1 ) )
- {
- checksPass = false;
- }
-
- if ( !fixChecksum( file, md5File, digestMd5 ) )
- {
- checksPass = false;
- }
-
- return checksPass;
- }
-
- private boolean createChecksum( File localFile, Digester digester )
- {
- try
- {
- checksumFile.createChecksum( localFile, digester );
- return true;
- }
- catch ( DigesterException e )
- {
- log.warn( "Unable to create " + digester.getFilenameExtension() + " file: " + e.getMessage(), e );
- return false;
- }
- catch ( IOException e )
- {
- log.warn( "Unable to create " + digester.getFilenameExtension() + " file: " + e.getMessage(), e );
- return false;
- }
- }
-
- private boolean fixChecksum( File localFile, File hashFile, Digester digester )
- {
- String ext = digester.getFilenameExtension();
-
- if ( !hashFile.getPath().endsWith( ext ) )
- {
- throw new IllegalArgumentException( "Cannot fix " + hashFile.getPath() + " using " + ext + " digester." );
- }
-
- // If hashfile doesn't exist, create it.
- if ( !hashFile.exists() )
- {
- return createChecksum( localFile, digester );
- }
-
- // Validate checksum, if bad, recreate it.
- try
- {
- if ( checksumFile.isValidChecksum( hashFile ) )
- {
- log.debug( "Valid checksum: " + hashFile.getPath() );
- return true;
- }
- else
- {
- log.debug( "Not valid checksum: " + hashFile.getPath() );
- return createChecksum( localFile, digester );
- }
- }
- catch ( FileNotFoundException e )
- {
- log.warn( "Unable to find " + ext + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- catch ( DigesterException e )
- {
- log.warn( "Unable to process " + ext + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- catch ( IOException e )
- {
- log.warn( "Unable to process " + ext + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- }
-
- private File getMd5File( File file )
- {
- return new File( file.getAbsolutePath() + ".md5" );
- }
-
- private File getSha1File( File file )
- {
- return new File( file.getAbsolutePath() + ".sha1" );
-
- }
-
- private boolean validateChecksum( File hashFile, String type )
- {
- try
- {
- boolean validity = checksumFile.isValidChecksum( hashFile );
- if ( validity )
- {
- log.debug( "Valid checksum: " + hashFile.getPath() );
- }
- else
- {
- log.debug( "Not valid checksum: " + hashFile.getPath() );
- }
- return validity;
- }
- catch ( FileNotFoundException e )
- {
- log.warn( "Unable to find " + type + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- catch ( DigesterException e )
- {
- log.warn( "Unable to process " + type + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- catch ( IOException e )
- {
- log.warn( "Unable to process " + type + " file: " + hashFile.getAbsolutePath(), e );
- return false;
- }
- }
-}
diff --git a/archiva-modules/archiva-base/archiva-common/src/test/java/org/apache/maven/archiva/common/utils/ChecksumsTest.java b/archiva-modules/archiva-base/archiva-common/src/test/java/org/apache/maven/archiva/common/utils/ChecksumsTest.java
deleted file mode 100644
index 5cbe361aa..000000000
--- a/archiva-modules/archiva-base/archiva-common/src/test/java/org/apache/maven/archiva/common/utils/ChecksumsTest.java
+++ /dev/null
@@ -1,291 +0,0 @@
-package org.apache.maven.archiva.common.utils;
-
-/*
- * 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.
- */
-
-import org.apache.commons.io.FileUtils;
-import org.codehaus.plexus.spring.PlexusInSpringTestCase;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileReader;
-
-/**
- * ChecksumsTest
- *
- * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
- * @version $Id$
- */
-public class ChecksumsTest
- extends PlexusInSpringTestCase
-{
- private static final String GOOD = "good";
-
- private static final String BAD = "bad";
-
- public void testCheckOnFileOnly()
- throws Exception
- {
- assertCheck( false, null, null );
- }
-
- public void testCheckOnFileWithBadMd5AndBadSha1()
- throws Exception
- {
- assertCheck( false, BAD, BAD );
- }
-
- public void testCheckOnFileWithBadMd5AndGoodSha1()
- throws Exception
- {
- assertCheck( false, BAD, GOOD );
- }
-
- public void testCheckOnFileWithBadMd5Only()
- throws Exception
- {
- assertCheck( false, BAD, null );
- }
-
- public void testCheckOnFileWithBadSha1Only()
- throws Exception
- {
- assertCheck( false, null, BAD );
- }
-
- public void testCheckOnFileWithGoodMd5AndBadSha1()
- throws Exception
- {
- assertCheck( false, GOOD, BAD );
- }
-
- public void testCheckOnFileWithGoodMd5AndGoodSha1()
- throws Exception
- {
- assertCheck( true, GOOD, GOOD );
- }
-
- public void testCheckOnFileWithGoodMd5Only()
- throws Exception
- {
- assertCheck( true, GOOD, null );
- }
-
- public void testCheckOnFileWithGoodSha1Only()
- throws Exception
- {
- assertCheck( true, null, GOOD );
- }
-
- public void testUpdateOnFileOnly()
- throws Exception
- {
- assertUpdate( true, null, null );
- }
-
- public void testUpdateOnFileWithBadMd5AndBadSha1()
- throws Exception
- {
- assertUpdate( true, BAD, BAD );
- }
-
- public void testUpdateOnFileWithBadMd5AndGoodSha1()
- throws Exception
- {
- assertUpdate( true, BAD, GOOD );
- }
-
- public void testUpdateOnFileWithBadMd5Only()
- throws Exception
- {
- assertUpdate( true, BAD, null );
- }
-
- public void testUpdateOnFileWithBadSha1Only()
- throws Exception
- {
- assertUpdate( true, null, BAD );
- }
-
- public void testUpdateOnFileWithGoodMd5AndBadSha1()
- throws Exception
- {
- assertUpdate( true, GOOD, BAD );
- }
-
- public void testUpdateOnFileWithGoodMd5AndGoodSha1()
- throws Exception
- {
- assertUpdate( true, GOOD, GOOD );
- }
-
- public void testUpdateOnFileWithGoodMd5Only()
- throws Exception
- {
- assertUpdate( true, GOOD, null );
- }
-
- public void testUpdateOnFileWithGoodSha1Only()
- throws Exception
- {
- assertUpdate( true, null, GOOD );
- }
-
- private void assertCheck( boolean expectedResult, String md5State, String sha1State )
- throws Exception
- {
- Checksums checksums = lookupChecksums();
- File localFile = createTestableFiles( md5State, sha1State );
-
- boolean actualResult = checksums.check( localFile );
- String msg = createMessage( "check", md5State, sha1State );
-
- if ( actualResult == false )
- {
- assertFalse( msg + " local file should not exist:", localFile.exists() );
- File md5File = new File( localFile.getAbsolutePath() + ".sha1" );
- File sha1File = new File( localFile.getAbsolutePath() + ".md5" );
- assertFalse( msg + " local md5 file should not exist:", md5File.exists() );
- assertFalse( msg + " local sha1 file should not exist:", sha1File.exists() );
- }
-
- assertEquals( msg, expectedResult, actualResult );
- }
-
- private void assertUpdate( boolean expectedResult, String md5State, String sha1State )
- throws Exception
- {
- Checksums checksums = lookupChecksums();
- File localFile = createTestableFiles( md5State, sha1State );
-
- boolean actualResult = checksums.update( localFile );
- String msg = createMessage( "update", md5State, sha1State );
- assertEquals( msg, expectedResult, actualResult );
-
- // End result should be legitimate SHA1 and MD5 files.
- File md5File = new File( localFile.getAbsolutePath() + ".md5" );
- File sha1File = new File( localFile.getAbsolutePath() + ".sha1" );
-
- assertTrue( "ChecksumPolicy.apply(FIX) md5 should exist.", md5File.exists() && md5File.isFile() );
- assertTrue( "ChecksumPolicy.apply(FIX) sha1 should exist.", sha1File.exists() && sha1File.isFile() );
-
- String actualMd5Contents = readChecksumFile( md5File );
- String actualSha1Contents = readChecksumFile( sha1File );
-
- String expectedMd5Contents = "360ccd01d8a0a2d94b86f9802c2fc548 artifact.jar";
- String expectedSha1Contents = "7dd8929150664f182db60ad15f20359d875f059f artifact.jar";
-
- assertEquals( msg + ": md5 contents:", expectedMd5Contents, actualMd5Contents );
- assertEquals( msg + ": sha1 contents:", expectedSha1Contents, actualSha1Contents );
- }
-
- /**
- * Read the first line from the checksum file, and return it (trimmed).
- */
- private String readChecksumFile( File checksumFile )
- throws Exception
- {
- FileReader freader = null;
- BufferedReader buf = null;
-
- try
- {
- freader = new FileReader( checksumFile );
- buf = new BufferedReader( freader );
- return buf.readLine();
- }
- finally
- {
- if ( buf != null )
- {
- buf.close();
- }
-
- if ( freader != null )
- {
- freader.close();
- }
- }
- }
-
- private String createMessage( String method, String md5State, String sha1State )
- {
- StringBuffer msg = new StringBuffer();
- msg.append( "Expected result of Checksums." ).append( method );
- msg.append( "() when working with " );
- if ( md5State == null )
- {
- msg.append( "NO" );
- }
- else
- {
- msg.append( "a " ).append( md5State.toUpperCase() );
- }
-
- msg.append( " MD5 and " );
-
- if ( sha1State == null )
- {
- msg.append( "NO" );
- }
- else
- {
- msg.append( "a " ).append( sha1State.toUpperCase() );
- }
- msg.append( " SHA1:" );
-
- return msg.toString();
- }
-
- private File createTestableFiles( String md5State, String sha1State )
- throws Exception
- {
-
- File destDir = new File( "target/checksum-tests/" + getName() + "/" );
-
- FileUtils.copyFileToDirectory( ResourceUtils.getResource( "/checksums/artifact.jar" ), destDir );
-
- if ( md5State != null )
- {
- File md5File = ResourceUtils.getResource( "/checksums/artifact.jar.md5-" + md5State );
- assertTrue( "Testable file exists: " + md5File.getName() + ":", md5File.exists() && md5File.isFile() );
- File destFile = new File( destDir, "artifact.jar.md5" );
- FileUtils.copyFile( md5File, destFile );
- }
-
- if ( sha1State != null )
- {
- File sha1File = ResourceUtils.getResource( "/checksums/artifact.jar.sha1-" + sha1State );
- assertTrue( "Testable file exists: " + sha1File.getName() + ":", sha1File.exists() && sha1File.isFile() );
- File destFile = new File( destDir, "artifact.jar.sha1" );
- FileUtils.copyFile( sha1File, destFile );
- }
-
- File localFile = new File( destDir, "artifact.jar" );
- return localFile;
- }
-
- private Checksums lookupChecksums()
- throws Exception
- {
- Checksums checksums = (Checksums) lookup( Checksums.class );
- assertNotNull( checksums );
- return checksums;
- }
-}