% UTP_AO_MD5 a set of UTPs for the ao/md5 method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_md5.m,v 1.4 2010/05/06 07:22:05 ingo Exp $
%

% <MethodDescription>
%
% The md5 method of the ao class computes an MD5 checksum from an analysis
% objects which is first converted into a XML document.
%
% </MethodDescription>

function results = utp_ao_md5(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'md5';

    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = get_test_objects_ao;

    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();

    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input
    results = [results utp_03];    % Matrix input
    results = [results utp_04];    % List input
    results = [results utp_05];    % Test with mixed input
    results = [results utp_06];    % Spcial case: one AO retruns a string
    
    disp('Done.');
    disp('******************************************************');

  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    else
      results = 0;
    end
  else
    error('### Incorrect inputs')
  end

  %% UTP_01

  % <TestDescription>
  %
  % Tests that the getInfo call works for this method.
  %
  % </TestDescription>
  function result = utp_01


    % <SyntaxDescription>
    %
    % Test that the getInfo call works for no sets, all sets, and each set
    % individually.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Call for no sets
      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
      % Call for all sets
      io(2) = eval([class '.getInfo(''' mthd ''')']);
      % Call for each set
      for kk=1:numel(io(2).sets)
        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
      end
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % check we have minfo objects
      if isa(io, 'minfo')
        % SET 'None'
        if ~isempty(io(1).sets), atest = false; end
        if ~isempty(io(1).plists), atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        % SET 'Default'
        if io(3).plists.nparams ~= 0, atest = false; end
        % Check key
        % Check default value
        % Check options
      end
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_01

  %% UTP_02

  % <TestDescription>
  %
  % Tests that the md5 method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the md5 method works for a vector of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = md5(atvec);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' are the same as in 'atvec'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atvec)), atest = false; end
      % Check each output against the md5 of the XML document
      for kk=1:numel(out)
        % Create XML document
        xml = com.mathworks.xml.XMLUtils.createDocument('ltpda_object');
        parent = xml.getDocumentElement;
        utils.xml.xmlwrite(atvec(kk), xml, parent, '');
        xml_txt = xmlwrite(xml);
        xml_txt = uint8(xml_txt);
        xml_txt = xml_txt(:);

        % Compute java md5
        md5_java = java.security.MessageDigest.getInstance('MD5');
        md5_java.update(xml_txt);
        
        md5_hex = typecast(md5_java.digest, 'uint8');
        md5_hex = dec2hex(md5_hex)';
        
        if ~strcmpi(out{kk}, md5_hex(:)'), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_02

  %% UTP_03

  % <TestDescription>
  %
  % Tests that the md5 method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Tests that the md5 method works with a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = md5(atmat);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' are the same as in 'atmat'
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(atmat)), atest = false; end
      % Check each output against the md5 of the XML document
      for kk=1:numel(out)
        % Create XML document
        xml = com.mathworks.xml.XMLUtils.createDocument('ltpda_object');
        parent = xml.getDocumentElement;
        utils.xml.xmlwrite(atmat(kk), xml, parent, '');
        xml_txt = xmlwrite(xml);
        xml_txt = uint8(xml_txt);
        xml_txt = xml_txt(:);

        % Compute java md5
        md5_java = java.security.MessageDigest.getInstance('MD5');
        md5_java.update(xml_txt);
        
        md5_hex = typecast(md5_java.digest, 'uint8');
        md5_hex = dec2hex(md5_hex)';
        
        if ~strcmpi(out{kk}, md5_hex(:)'), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_03

  %% UTP_04

  % <TestDescription>
  %
  % Tests that the md5 method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Tests that the md5 method works with a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = md5(at1, at2, at3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' are the same as in the input
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1, at2, at3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check each output against the md5 of the XML document
      for kk=1:numel(out)
        % Create XML document
        xml = com.mathworks.xml.XMLUtils.createDocument('ltpda_object');
        parent = xml.getDocumentElement;
        utils.xml.xmlwrite(aoin(kk), xml, parent, '');
        xml_txt = xmlwrite(xml);
        xml_txt = uint8(xml_txt);
        xml_txt = xml_txt(:);

        % Compute java md5
        md5_java = java.security.MessageDigest.getInstance('MD5');
        md5_java.update(xml_txt);
        
        md5_hex = typecast(md5_java.digest, 'uint8');
        md5_hex = dec2hex(md5_hex)';
        
        if ~strcmpi(out{kk}, md5_hex(:)'), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_04

  %% UTP_05

  % <TestDescription>
  %
  % Tests that the md5 method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Tests that the md5 method works with a mix of different shaped AOs as
    % input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = md5(atvec, at2, atmat);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' are the same as in the input
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [reshape(atvec,1,[]), at2, reshape(atmat,1,[])];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(aoin)), atest = false; end
      % Check each output against the md5 of the XML document
      for kk=1:numel(out)
        % Create XML document
        xml = com.mathworks.xml.XMLUtils.createDocument('ltpda_object');
        parent = xml.getDocumentElement;
        utils.xml.xmlwrite(aoin(kk), xml, parent, '');
        xml_txt = xmlwrite(xml);
        xml_txt = uint8(xml_txt);
        xml_txt = xml_txt(:);

        % Compute java md5
        md5_java = java.security.MessageDigest.getInstance('MD5');
        md5_java.update(xml_txt);
        
        md5_hex = typecast(md5_java.digest, 'uint8');
        md5_hex = dec2hex(md5_hex)';
        
        if ~strcmpi(out{kk}, md5_hex(:)'), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05

  %% UTP_06

  % <TestDescription>
  %
  % Tests that the md5 method retruns for one input a string and not a cell
  % of a string
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Special case for one input because in this case retruns md5 a string
    % and not a cell.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out = md5(at4);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a string
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that the output is a string
      if~ischar(out), atest = false; end
      % Check each output against the md5 of the XML document
      % Create XML document
      xml = com.mathworks.xml.XMLUtils.createDocument('ltpda_object');
      parent = xml.getDocumentElement;
      utils.xml.xmlwrite(at4, xml, parent, '');
      xml_txt = xmlwrite(xml);
      xml_txt = uint8(xml_txt);
      xml_txt = xml_txt(:);
      
      % Compute java md5
      md5_java = java.security.MessageDigest.getInstance('MD5');
      md5_java.update(xml_txt);
      
      md5_hex = typecast(md5_java.digest, 'uint8');
      md5_hex = dec2hex(md5_hex)';
      
      if ~strcmpi(out, md5_hex(:)'), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06

end