tools/tradefed-host/src/com/android/cts/tradefed/result/TestResults.java

/*
 * Copyright (C) 2010 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.cts.tradefed.result;

import com.android.cts.tradefed.build.CtsBuildProvider;
import com.android.cts.util.AbiUtils;
import com.android.tradefed.log.LogUtil.CLog;

import org.kxml2.io.KXmlSerializer;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;

import java.io.IOException;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * Data structure for the detailed CTS test results.
 * <p/>
 * Can deserialize results for test packages from XML
 */
class TestResults extends AbstractXmlPullParser {

    private static final String ns = CtsXmlResultReporter.ns;

    // XML constants
    static final String SUMMARY_TAG = "Summary";
    static final String PASS_ATTR = "pass";
    static final String TIMEOUT_ATTR = "timeout";
    static final String NOT_EXECUTED_ATTR = "notExecuted";
    static final String FAILED_ATTR = "failed";

    private Map<String, TestPackageResult> mPackageResults =
            new LinkedHashMap<String, TestPackageResult>();
    private DeviceInfoResult mDeviceInfo = new DeviceInfoResult();

    /**
     * {@inheritDoc}
     */
    @Override
    void parse(XmlPullParser parser) throws XmlPullParserException, IOException {
        int eventType = parser.getEventType();
        while (eventType != XmlPullParser.END_DOCUMENT) {
            if (eventType == XmlPullParser.START_TAG && parser.getName().equals(
                    DeviceInfoResult.TAG)) {
                mDeviceInfo.parse(parser);
            }
            if (eventType == XmlPullParser.START_TAG && parser.getName().equals(
                    TestPackageResult.TAG)) {
                TestPackageResult pkg = new TestPackageResult();
                pkg.parse(parser);
                if (pkg.getId() != null) {
                    mPackageResults.put(pkg.getId(), pkg);
                } else {
                    CLog.w("Found package with no id");
                }
            }
            eventType = parser.next();
        }
    }

    /**
     * @return the list of {@link TestPackageResult}.
     */
    public Collection<TestPackageResult> getPackages() {
        return mPackageResults.values();
    }

    /**
     * Count the number of tests with given status
     * @param status
     */
    public int countTests(CtsTestStatus status) {
        int total = 0;
        for (TestPackageResult result : mPackageResults.values()) {
            total += result.countTests(status);
        }
        return total;
    }

    /**
     * Serialize the test results to XML.
     *
     * @param serializer
     * @throws IOException
     */
    public void serialize(KXmlSerializer serializer, String buildId) throws IOException {
        mDeviceInfo.serialize(serializer);
        serializeHostInfo(serializer, buildId);
        serializeTestSummary(serializer);
        // sort before serializing
        List<TestPackageResult> pkgs = new ArrayList<TestPackageResult>(mPackageResults.values());
        Collections.sort(pkgs, new PkgComparator());
        for (TestPackageResult r : pkgs) {
            r.serialize(serializer);
        }
    }

    /**
     * Output the host info XML.
     *
     * @param serializer
     */
    private void serializeHostInfo(KXmlSerializer serializer, String buildId) throws IOException {
        serializer.startTag(ns, "HostInfo");

        String hostName = "";
        try {
            hostName = InetAddress.getLocalHost().getHostName();
        } catch (UnknownHostException ignored) {}
        serializer.attribute(ns, "name", hostName);

        serializer.startTag(ns, "Os");
        serializer.attribute(ns, "name", System.getProperty("os.name"));
        serializer.attribute(ns, "version", System.getProperty("os.version"));
        serializer.attribute(ns, "arch", System.getProperty("os.arch"));
        serializer.endTag(ns, "Os");

        serializer.startTag(ns, "Java");
        serializer.attribute(ns, "name", System.getProperty("java.vendor"));
        serializer.attribute(ns, "version", System.getProperty("java.version"));
        serializer.endTag(ns, "Java");

        serializer.startTag(ns, "Cts");
        serializer.attribute(ns, "version", CtsBuildProvider.CTS_BUILD_VERSION);
        serializer.attribute(ns, "build", buildId);
        // TODO: consider outputting other tradefed options here
        serializer.startTag(ns, "IntValue");
        serializer.attribute(ns, "name", "testStatusTimeoutMs");
        // TODO: create a constant variable for testStatusTimeoutMs value. Currently it cannot be
        // changed
        serializer.attribute(ns, "value", "600000");
        serializer.endTag(ns, "IntValue");
        serializer.endTag(ns, "Cts");

        serializer.endTag(ns, "HostInfo");
    }

    /**
     * Output the test summary XML containing summary totals for all tests.
     *
     * @param serializer
     * @throws IOException
     */
    private void serializeTestSummary(KXmlSerializer serializer) throws IOException {
        serializer.startTag(ns, SUMMARY_TAG);
        serializer.attribute(ns, FAILED_ATTR, Integer.toString(countTests(CtsTestStatus.FAIL)));
        serializer.attribute(ns, NOT_EXECUTED_ATTR,
                Integer.toString(countTests(CtsTestStatus.NOT_EXECUTED)));
        // ignore timeouts - these are reported as errors
        serializer.attribute(ns, TIMEOUT_ATTR, "0");
        serializer.attribute(ns, PASS_ATTR, Integer.toString(countTests(CtsTestStatus.PASS)));
        serializer.endTag(ns, SUMMARY_TAG);
    }

    private static class PkgComparator implements Comparator<TestPackageResult> {

        @Override
        public int compare(TestPackageResult lhs, TestPackageResult rhs) {
            return lhs.getId().compareTo(rhs.getId());
        }
    }

    /**
     * Return existing package with given id. If not found, create a new one.
     * @param id
     * @return
     */
    public TestPackageResult getOrCreatePackage(String id) {
        TestPackageResult pkgResult = mPackageResults.get(id);
        if (pkgResult == null) {
            pkgResult = new TestPackageResult();
            String[] abiAndName = AbiUtils.parseId(id);
            pkgResult.setAbi(abiAndName[0]);
            pkgResult.setAppPackageName(abiAndName[1]);
            mPackageResults.put(id, pkgResult);
        }
        return pkgResult;
    }

    /**
     * Populate the results with collected device info metrics.
     * @param runMetrics
     */
    public void populateDeviceInfoMetrics(Map<String, String> runMetrics) {
        mDeviceInfo.populateMetrics(runMetrics);
    }
}