/**
* Copyright (C) 2010-2014 Morgner UG (haftungsbeschränkt)
*
* This file is part of Structr <http://structr.org>.
*
* Structr is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* Structr 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 General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Structr. If not, see <http://www.gnu.org/licenses/>.
*/
package org.structr.web.common;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import static junit.framework.TestCase.assertEquals;
import static junit.framework.TestCase.assertNotNull;
import static junit.framework.TestCase.assertTrue;
import static junit.framework.TestCase.fail;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;
import org.structr.common.SecurityContext;
import org.structr.common.error.FrameworkException;
import org.structr.core.app.StructrApp;
import org.structr.core.entity.AbstractUser;
import org.structr.core.graph.Tx;
import org.structr.core.property.PropertyMap;
import org.structr.dynamic.File;
import org.structr.web.entity.AbstractFile;
import org.structr.web.entity.Folder;
import org.structr.web.entity.User;
/**
* Common class for FTP tests
*
* @author Axel Morgner
*/
public class FtpTest extends StructrUiTest {
private static final Logger logger = Logger.getLogger(FtpTest.class.getName());
protected User ftpUser;
protected User createFTPUser(final String username, final String password) throws FrameworkException {
PropertyMap props = new PropertyMap();
props.put(AbstractUser.name, username);
props.put(AbstractUser.password, password);
return (User) createTestNodes(User.class, 1, props).get(0);
}
protected Folder createFTPDirectory(final String path, final String name) throws FrameworkException {
PropertyMap props = new PropertyMap();
props.put(Folder.name, name);
props.put(Folder.owner, ftpUser);
Folder dir = (Folder) createTestNodes(Folder.class, 1, props).get(0);
if (StringUtils.isNotBlank(path)) {
AbstractFile parent = FileHelper.getFileByAbsolutePath(SecurityContext.getSuperUserInstance(), path);
if (parent != null && parent instanceof Folder) {
Folder parentFolder = (Folder) parent;
dir.setProperty(Folder.parent, parentFolder);
}
}
logger.log(Level.INFO, "FTP directory {0} created successfully.", dir);
return dir;
}
protected File createFTPFile(final String path, final String name) throws FrameworkException {
PropertyMap props = new PropertyMap();
props.put(File.name, name);
props.put(File.size, 0L);
props.put(File.owner, ftpUser);
File file = (File) createTestNodes(File.class, 1, props).get(0);
if (StringUtils.isNotBlank(path)) {
AbstractFile parent = FileHelper.getFileByAbsolutePath(SecurityContext.getSuperUserInstance(), path);
if (parent != null && parent instanceof Folder) {
Folder parentFolder = (Folder) parent;
file.setProperty(Folder.parent, parentFolder);
}
}
logger.log(Level.INFO, "FTP file {0} created successfully.", file);
return file;
}
protected void assertEmptyDirectory(final FTPClient ftp) {
FTPFile[] dirs = null;
try {
dirs = ftp.listDirectories();
} catch (IOException ex) {
logger.log(Level.SEVERE, "Error in FTP test", ex);
fail("Unexpected exception: " + ex.getMessage());
}
assertNotNull(dirs);
assertEquals(0, dirs.length);
}
/**
* Creates an FTP client, a backend user and logs this user in.
*
* @return
*/
protected FTPClient setupFTPClient() {
FTPClient ftp = new FTPClient();
try {
ftp.connect("localhost", ftpPort);
logger.log(Level.INFO, "Reply from FTP server:", ftp.getReplyString());
int reply = ftp.getReplyCode();
assertTrue(FTPReply.isPositiveCompletion(reply));
String username = "ftpuser1";
String password = "ftpuserpw1";
try (final Tx tx = StructrApp.getInstance(securityContext).tx()) {
ftpUser = createFTPUser(username, password);
tx.success();
} catch (FrameworkException fex) {
logger.log(Level.SEVERE, "Unable to create FTP user", fex);
}
boolean loginSuccess = ftp.login(username, password);
logger.log(Level.INFO, "Try to login as " + username + "/" + password + ": ", loginSuccess);
assertTrue(loginSuccess);
reply = ftp.getReplyCode();
assertEquals(FTPReply.USER_LOGGED_IN, reply);
} catch (IOException ex) {
logger.log(Level.SEVERE, "Error in FTP test", ex);
fail("Unexpected exception: " + ex.getMessage());
}
return ftp;
}
protected void disconnect(final FTPClient ftp) {
try {
ftp.disconnect();
} catch (IOException ex) {
logger.log(Level.SEVERE, "Error while disconnecting from FTP server", ex);
fail("Unexpected exception: " + ex.getMessage());
}
}
}