tests/src/com/android/vcard/tests/VCardParserTests.java

/*
 * Copyright (C) 2011 The Android Open Source Project
 *
 * Licensed 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.
 */
package com.android.vcard.tests;

import com.android.vcard.VCardInterpreter;
import com.android.vcard.VCardParser;
import com.android.vcard.VCardParser_V21;
import com.android.vcard.VCardParser_V30;
import com.android.vcard.VCardProperty;
import com.android.vcard.exception.VCardException;

import android.test.AndroidTestCase;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Tests for basic {@link VCardParser} capability (e.g. if it calls callbacks
 * in {@link VCardInterpreter}}.
 */
public class VCardParserTests extends AndroidTestCase {
    private enum Order {
        START,
        END,
        START_ENTRY,
        END_ENTRY,
        PROPERTY_CREATED,
    }

    private class MockVCardInterpreter implements VCardInterpreter {
        private final List<Order> mHistory = new ArrayList<Order>();
        private final List<Order> mExpectedOrder = new ArrayList<Order>();

        public MockVCardInterpreter addExpectedOrder(Order order) {
            mExpectedOrder.add(order);
            return this;
        }

        private void inspectOrder(Order order) {
            mHistory.add(order);
            final Order top = mExpectedOrder.get(0);
            assertEquals(top, order);
            mExpectedOrder.remove(0);
        }

        public void verify() {
            assertTrue(String.format("Remaining: " + Arrays.toString(mExpectedOrder.toArray())),
                    mExpectedOrder.isEmpty());
        }

        @Override
        public void onVCardStarted() {
            inspectOrder(Order.START);
        }

        @Override
        public void onVCardEnded() {
            inspectOrder(Order.END);
        }

        @Override
        public void onEntryStarted() {
            inspectOrder(Order.START_ENTRY);
        }

        @Override
        public void onEntryEnded() {
            inspectOrder(Order.END_ENTRY);
        }

        @Override
        public void onPropertyCreated(VCardProperty property) {
            inspectOrder(Order.PROPERTY_CREATED);
        }
    }

    public void testSimple() throws IOException, VCardException {
        InputStream inputStream = getContext().getResources().openRawResource(R.raw.v21_simple_1);
        try {
            VCardParser parser = new VCardParser_V21();
            MockVCardInterpreter interpreter = new MockVCardInterpreter();
            interpreter.addExpectedOrder(Order.START)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.END);
            parser.addInterpreter(interpreter);
            parser.parse(inputStream);
            interpreter.verify();
        } finally {
            inputStream.close();
        }
    }

    public void testNest() throws IOException, VCardException {
        InputStream inputStream = getContext().getResources().openRawResource(R.raw.v21_nest);
        try {
            VCardParser parser = new VCardParser_V21();
            MockVCardInterpreter interpreter = new MockVCardInterpreter();
            interpreter.addExpectedOrder(Order.START)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.START_ENTRY)  // First nested vCard begins
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.END_ENTRY)  // First nested vCard ends
                    .addExpectedOrder(Order.START_ENTRY)  // Second nested vCard begins
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.END_ENTRY)  // Second nested vCard ends
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.END);
            parser.addInterpreter(interpreter);
            parser.parse(inputStream);
            interpreter.verify();
        } finally {
            inputStream.close();
        }
    }

    /**
     * Test vCard containing v3.0 line continuations and with non-standard
     * line terminators \r\r\n coming from iOS 6.1.3. Tests to make sure the
     * parser correctly skips the extra line terminators and still
     * successfully concatenates the multi-line block.
     */
    public void testIosMultiline() throws IOException, VCardException {
        InputStream inputStream = getContext().getResources().openRawResource(R.raw.v30_ios_613_multiline);
        try {
            VCardParser parser = new VCardParser_V30();
            MockVCardInterpreter interpreter = new MockVCardInterpreter();
            interpreter.addExpectedOrder(Order.START)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For FN
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For ORG
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For item1
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For item2
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For item3
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For PHOTO
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.END);
            parser.addInterpreter(interpreter);
            parser.parse(inputStream);
            interpreter.verify();
        } finally {
            inputStream.close();
        }
    }

    /**
     * Tests if {@link VCardParser#parse(InputStream)} parses the whole vCard file and
     * {@link VCardParser#parseOne(InputStream)} parses just first entry of a vCard file
     * with multiple vCard entries.
     */
    public void testParseOne() throws IOException, VCardException {
        InputStream inputStream =
                getContext().getResources().openRawResource(R.raw.v21_multiple_entry);
        try {
            VCardParser parser = new VCardParser_V21();
            MockVCardInterpreter interpreter = new MockVCardInterpreter();
            interpreter.addExpectedOrder(Order.START)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For SOUND
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For SOUND
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For SOUND
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.END);
            parser.addInterpreter(interpreter);
            // Use parse() to check we
            parser.parse(inputStream);
            interpreter.verify();
        } finally {
            inputStream.close();
        }

        inputStream = getContext().getResources().openRawResource(R.raw.v21_multiple_entry);
        try {
            VCardParser parser = new VCardParser_V21();
            MockVCardInterpreter interpreter = new MockVCardInterpreter();
            interpreter.addExpectedOrder(Order.START)
                    .addExpectedOrder(Order.START_ENTRY)
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For VERSION
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For N
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For SOUND
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.PROPERTY_CREATED)  // For TEL
                    .addExpectedOrder(Order.END_ENTRY)
                    .addExpectedOrder(Order.END);
            parser.addInterpreter(interpreter);
            parser.parseOne(inputStream);
            interpreter.verify();
        } finally {
            inputStream.close();
        }

    }
}