classdef AttributeTest < matlab.unittest.TestCase 
% ATTRIBUTETEST
%
% Description:
%   Tests HDF5 operations involving attributes
%
% Use:
%   results = runtests('AttributeTest');
%
% See also;
%   runH5toolsTestSuite
% -------------------------------------------------------------------------

    properties
        FILE 
    end

    methods (TestClassSetup)
        function createFile(testCase)
            folder = fileparts(mfilename('fullpath'));
            testCase.FILE = fullfile(folder, 'AttributeTest.h5');
            h5tools.createFile(testCase.FILE, true);

            % Create two groups for map and struct input testing
            h5tools.createGroup(testCase.FILE, '/',... 
                'Map', 'Struct', 'MapKV', 'StructKV');
            % Create a dataset for group vs dataset testing
            h5tools.write(testCase.FILE, '/', 'Dataset', magic(5));
        end
    end

    methods (Test, TestTags=["Inputs"])
        function ContainerInput(testCase)
            map = containers.Map();
            map('Att1') = 1;
            map('Att2') = "a";
            
            h5tools.writeatt(testCase.FILE, '/Map', map);
            out = h5tools.getAttributeNames(testCase.FILE, '/Map');
            testCase.verifyNumElements(out, 2);
        end

        function ContainerKVInput(testCase)
            map = containers.Map();
            map('A') = 1; map('B') = 'b';

            h5tools.writeatt(testCase.FILE, '/MapKV', map, 'C', 1:3);
            out = h5tools.getAttributeNames(testCase.FILE, '/MapKV');
            testCase.verifyNumElements(out, 3);
        end

        function Struct(testCase)
            S = struct('Att1', 1, 'Att2', "a");
            h5tools.writeatt(testCase.FILE, '/Struct', S);
            out = h5tools.getAttributeNames(testCase.FILE, '/Struct');
            testCase.verifyNumElements(out, 2);
        end

        function NoInput(testCase)
            testCase.verifyWarning(...
                @() h5tools.writeatt(testCase.FILE, '/'),...
                "writeatt:NoInput");
        end
    end

    methods (Test, TestTags=["Deletion"])
        function DeletionFromGroup(testCase)
            import matlab.unittest.constraints.Throws
            
            h5tools.writeatt(testCase.FILE, '/', 'ToBeDeleted', "sara");
            h5tools.deleteAttribute(testCase.FILE, '/', 'ToBeDeleted');
            testCase.verifyThat(...
                @() h5tools.readatt(testCase.FILE, '/', 'ToBeDeleted'),...
                Throws('MATLAB:imagesci:hdf5lib:libraryError'));
        end

        function DeletionFromDataset(testCase)
            import matlab.unittest.constraints.Throws
            
            h5tools.writeatt(testCase.FILE, '/Dataset', 'ToBeDeleted', "sara");
            h5tools.deleteAttribute(testCase.FILE, '/Dataset', 'ToBeDeleted');
            testCase.verifyThat(...
                @() h5tools.readatt(testCase.FILE, '/', 'ToBeDeleted'),...
                Throws('MATLAB:imagesci:hdf5lib:libraryError'));
        end
    end
    
    methods (Test, TestTags=["Numeric"])
        function DoubleArray(testCase)
            input = magic(5);
            h5tools.writeatt(testCase.FILE, '/', 'DoubleArray', input);
            output = h5tools.readatt(testCase.FILE, '/', 'DoubleArray');
            testCase.verifyEqual(output, input);
        end
    end

    methods (Test, TestTags=["String"])
        function ScalarString(testCase)
            input = "test";
            h5tools.writeatt(testCase.FILE, '/', 'ScalarString', input);
            output = h5tools.readatt(testCase.FILE, '/', 'ScalarString');
            testCase.verifyEqual(output, input);
        end

        function ScalarVector(testCase)
            input = ["test", "string", "row"];
            h5tools.writeatt(testCase.FILE, '/', 'StringArrayRow', input);
            output = h5tools.readatt(testCase.FILE, '/', 'StringArrayRow');
            testCase.verifyEqual(output, input');

            h5tools.writeatt(testCase.FILE, '/', 'StringArrayCol', input');
            output = h5tools.readatt(testCase.FILE, '/', 'StringArrayCol');
            testCase.verifyEqual(output, input');
        end
    end

    methods (Test, TestTags = ["Logical"])
        function Logical(testCase)
            h5tools.writeatt(testCase.FILE, '/', 'LogicalTrue', true);
            testCase.verifyTrue(h5tools.readatt(testCase.FILE, '/', 'LogicalTrue'));

            h5tools.writeatt(testCase.FILE, '/', 'LogicalFalse', false);
            testCase.verifyFalse(h5tools.readatt(testCase.FILE, '/', 'LogicalFalse'));
        end

        function LogicalVector(testCase)
            input = [true, false, true, false];
            h5tools.writeatt(testCase.FILE, '/', 'LogicalArrayRow', input);
            output = h5tools.readatt(testCase.FILE, '/', 'LogicalArrayRow');
            testCase.verifyEqual(output, input);

            h5tools.writeatt(testCase.FILE, '/', 'LogicalArrayCol', input');
            output = h5tools.readatt(testCase.FILE, '/', 'LogicalArrayCol');
            testCase.verifyEqual(output, input');
        end

        function Logical2D(testCase)
            input = [true false; true true];
            h5tools.writeatt(testCase.FILE, '/', 'Logical2D', input);
            output = h5tools.readatt(testCase.FILE, '/', 'Logical2D');
            testCase.verifyEqual(output, input);
        end
    end

    methods (Test, TestTags = ["char"])
        function Char(testCase)
            input = 'test';
            h5tools.writeatt(testCase.FILE, '/', 'Char', input);
            output = h5tools.readatt(testCase.FILE, '/', 'Char');
            testCase.verifyEqual(output, input);
        end
    end

    methods (Test, TestTags=["enum"])
        function EnumScalar(testCase)
            input = test.EnumClass.GROUPONE;
            h5tools.writeatt(testCase.FILE, '/', 'EnumScalar', input);
            output = h5tools.readatt(testCase.FILE, '/', 'EnumScalar');
            testCase.verifyEqual(output, input);
        end

        function LooksLikeEnum(testCase)
            input = "FakeClass.GROUPONE";
            h5tools.writeatt(testCase.FILE, '/', 'LooksLikeEnum', input);
            output = h5tools.readatt(testCase.FILE, '/', 'LooksLikeEnum');
            testCase.verifyEqual(output, input);
        end
    end

    methods (Test, TestTags = ["datetime"])
        function DatetimeScalar(testCase)
            input = datetime('24-Oct-2014 12:45:07');
            h5tools.writeatt(testCase.FILE, '/', 'DatetimeScalar', input);
            output = h5tools.readatt(testCase.FILE, '/', 'DatetimeScalar');
            testCase.verifyEqual(output, input);
        end
    end

    methods (Test, TestTags=["duration", "unreadable"])
        function Duration(testCase)
            input = seconds(magic(5))';
            testCase.verifyWarning(...
                @() h5tools.writeatt(testCase.FILE, '/', 'Duration', input),...
                "writeAttributeByType:Duration");
            output = h5tools.readatt(testCase.FILE, '/', 'Duration');
            testCase.verifyClass(output, "double");
            testCase.verifyEqual(seconds(output), input);
        end
    end

    methods (Test, TestTags=["cellstr", "unreadable"])
        function Cellstr(testCase)
            input = {'abc', 'def'; 'ghi', 'klm'};
            testCase.verifyWarning(...
                @() h5tools.writeatt(testCase.FILE, '/', 'Cellstr', input),...
                "writeAttributeByType:Cellstr");
            output = h5tools.readatt(testCase.FILE, '/', 'Cellstr');
            testCase.verifyClass(output, "string");
            testCase.verifyEqual(cellstr(output), input);
        end
    end

    methods (Test, TestTags=["invalid"])
        function Table(testCase)
            import matlab.unittest.constraints.Throws

            input = struct("A", 1, "B", 2);
            testCase.verifyThat(...
                @()h5tools.writeatt(testCase.FILE, '/', 'Struct', input),...
                Throws("writeAttributeByType:InvalidInput"));
        end
    end

    methods (Test, TestTags=["Deletion"])
        function Deletion(testCase)
            % Write an attribute and confirm presence in attribute list
            h5tools.writeatt(testCase.FILE, '/', 'ToDelete', "deleteme");
            allAtts = h5tools.getAttributeNames(testCase.FILE, '/');
            testCase.verifyNumElements(allAtts(endsWith(allAtts, "ToDelete")), 1);
            
            % Delete the attribute and confirm the attribute is gone
            h5tools.deleteAttribute(testCase.FILE, '/', 'ToDelete');
            allAtts = h5tools.getAttributeNames(testCase.FILE, '/');
            testCase.verifyEmpty(allAtts(endsWith(allAtts, "ToDelete")), 1);
        end
    end
end