tests/BugReportApp/src/com/google/android/car/bugreport/MetaBugReport.java

/*
 * Copyright (C) 2019 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.google.android.car.bugreport;

import static java.lang.annotation.RetentionPolicy.SOURCE;

import android.annotation.IntDef;
import android.os.Parcel;
import android.os.Parcelable;

import com.google.auto.value.AutoValue;

import java.lang.annotation.Retention;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

/** Represents the information that a bugreport can contain. */
@AutoValue
abstract class MetaBugReport implements Parcelable {

    private static final DateFormat BUG_REPORT_TIMESTAMP_DATE_FORMAT =
            new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss");

    /** The app records audio message when initiated. Can change audio state. */
    static final int TYPE_INTERACTIVE = 0;

    /**
     * The app doesn't show dialog and doesn't record audio when initiated. It allows user to
     * add audio message when bugreport is collected.
     */
    static final int TYPE_SILENT = 1;

    /** Annotation for bug report types. */
    @Retention(SOURCE)
    @IntDef({TYPE_INTERACTIVE, TYPE_SILENT})
    @interface BugReportType {};

    /**
     * @return Id of the bug report. Bug report id monotonically increases and is unique.
     */
    public abstract int getId();

    /**
     * @return Username (LDAP) that created this bugreport
     */
    public abstract String getUserName();

    /**
     * @return Title of the bug.
     */
    public abstract String getTitle();

    /**
     * @return Timestamp when the bug report is initialized.
     */
    public abstract String getTimestamp();

    /**
     * @return path to the zip file stored under the system user.
     *
     * <p>NOTE: This is the old way of storing final zipped bugreport. See
     * {@link BugStorageProvider#URL_SEGMENT_OPEN_FILE} for more info.
     */
    public abstract String getFilePath();

    /**
     * @return filename of the bug report zip file stored under the system user.
     */
    public abstract String getBugReportFileName();

    /**
     * @return filename of the audio message file stored under the system user.
     */
    public abstract String getAudioFileName();

    /**
     * @return {@link Status} of the bug upload.
     */
    public abstract int getStatus();

    /**
     * @return StatusMessage of the bug upload.
     */
    public abstract String getStatusMessage();

    /**
     * @return {@link BugReportType}.
     */
    public abstract int getType();

    /** @return {@link Builder} from the meta bug report. */
    public abstract Builder toBuilder();

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeInt(getId());
        dest.writeString(getTimestamp());
        dest.writeString(getTitle());
        dest.writeString(getUserName());
        dest.writeString(getFilePath());
        dest.writeString(getBugReportFileName());
        dest.writeString(getAudioFileName());
        dest.writeInt(getStatus());
        dest.writeString(getStatusMessage());
        dest.writeInt(getType());
    }

    /** Converts {@link Date} to bugreport timestamp. */
    static String toBugReportTimestamp(Date date) {
        return BUG_REPORT_TIMESTAMP_DATE_FORMAT.format(date);
    }

    /** Creates a {@link Builder} with default, non-null values. */
    static Builder builder() {
        return new AutoValue_MetaBugReport.Builder()
                .setTimestamp("")
                .setFilePath("")
                .setBugReportFileName("")
                .setAudioFileName("")
                .setStatusMessage("")
                .setTitle("")
                .setUserName("");
    }

    /** A creator that's used by Parcelable. */
    public static final Parcelable.Creator<MetaBugReport> CREATOR =
            new Parcelable.Creator<MetaBugReport>() {
                public MetaBugReport createFromParcel(Parcel in) {
                    int id = in.readInt();
                    String timestamp = in.readString();
                    String title = in.readString();
                    String username = in.readString();
                    String filePath = in.readString();
                    String bugReportFileName = in.readString();
                    String audioFileName = in.readString();
                    int status = in.readInt();
                    String statusMessage = in.readString();
                    int type = in.readInt();
                    return MetaBugReport.builder()
                            .setId(id)
                            .setTimestamp(timestamp)
                            .setTitle(title)
                            .setUserName(username)
                            .setFilePath(filePath)
                            .setBugReportFileName(bugReportFileName)
                            .setAudioFileName(audioFileName)
                            .setStatus(status)
                            .setStatusMessage(statusMessage)
                            .setType(type)
                            .build();
                }

                public MetaBugReport[] newArray(int size) {
                    return new MetaBugReport[size];
                }
            };

    /** Builder for MetaBugReport. */
    @AutoValue.Builder
    abstract static class Builder {
        /** Sets id. */
        public abstract Builder setId(int id);

        /** Sets timestamp. */
        public abstract Builder setTimestamp(String timestamp);

        /** Sets title. */
        public abstract Builder setTitle(String title);

        /** Sets username. */
        public abstract Builder setUserName(String username);

        /** Sets filepath. */
        public abstract Builder setFilePath(String filePath);

        /** Sets bugReportFileName. */
        public abstract Builder setBugReportFileName(String bugReportFileName);

        /** Sets audioFileName. */
        public abstract Builder setAudioFileName(String audioFileName);

        /** Sets {@link Status}. */
        public abstract Builder setStatus(int status);

        /** Sets statusmessage. */
        public abstract Builder setStatusMessage(String statusMessage);

        /** Sets the {@link BugReportType}. */
        public abstract Builder setType(@BugReportType int type);

        public abstract MetaBugReport build();
    }
}