Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0c919fc1 authored by Atneya Nair's avatar Atneya Nair Committed by Android (Google) Code Review
Browse files

Merge changes I69bc716c,Ifc184548,I74075402 into udc-dev 

* changes:
  Sessionize STMiddleware logging
  SoundTriggerService logging cleanup
  Add SoundTrigger event types for logging
parents fcfe3ab9 55dcabec

services/tests/voiceinteractiontests/src/com/android/server/soundtrigger/SoundTriggerEventTest.java

0 → 100644
+87 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2023 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.server.soundtrigger;



import static com.google.common.truth.Truth.assertThat;



import androidx.test.runner.AndroidJUnit4;



import com.android.server.soundtrigger.SoundTriggerEvent.ServiceEvent;

import com.android.server.soundtrigger.SoundTriggerEvent.SessionEvent;



import org.junit.Test;

import org.junit.runner.RunWith;



import java.util.UUID;



@RunWith(AndroidJUnit4.class)

public final class SoundTriggerEventTest {

    private static final ServiceEvent.Type serviceEventType = ServiceEvent.Type.ATTACH;

    private static final SessionEvent.Type sessionEventType = SessionEvent.Type.DETACH;



    @Test

    public void serviceEventNoPackageNoError_getStringContainsType() {

        final var event = new ServiceEvent(serviceEventType);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(serviceEventType.name());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void serviceEventPackageNoError_getStringContainsTypeAndPackage() {

        final var packageName = "com.android.package.name";

        final var event = new ServiceEvent(serviceEventType, packageName);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(serviceEventType.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void serviceEventPackageError_getStringContainsTypeAndPackageAndErrorAndMessage() {

        final var packageName = "com.android.package.name";

        final var errorString = "oh no an ERROR occurred";

        final var event = new ServiceEvent(serviceEventType, packageName, errorString);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(serviceEventType.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).contains(errorString);

        assertThat(stringRep).ignoringCase().contains("error");

    }



    @Test

    public void sessionEventUUIDNoError_getStringContainsUUID() {

        final var uuid = new UUID(5, -7);

        final var event = new SessionEvent(sessionEventType, uuid);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(sessionEventType.name());

        assertThat(stringRep).contains(uuid.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void sessionEventUUIDError_getStringContainsUUIDAndError() {

        final var uuid = new UUID(5, -7);

        final var errorString = "oh no an ERROR occurred";

        final var event = new SessionEvent(sessionEventType, uuid, errorString);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(sessionEventType.name());

        assertThat(stringRep).contains(uuid.toString());

        assertThat(stringRep).ignoringCase().contains("error");

        assertThat(stringRep).contains(errorString);

    }

}

services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingTest.java

+139 −0
Original line number Original line Diff line number Diff line
@@ -16,6 +16,8 @@ 




package com.android.server.soundtrigger_middleware;

package com.android.server.soundtrigger_middleware;





import static com.android.server.soundtrigger_middleware.SoundTriggerMiddlewareLogging.ServiceEvent;

import static com.android.server.soundtrigger_middleware.SoundTriggerMiddlewareLogging.SessionEvent;

import static com.android.internal.util.LatencyTracker.ACTION_SHOW_VOICE_INTERACTION;

import static com.android.internal.util.LatencyTracker.ACTION_SHOW_VOICE_INTERACTION;





import static com.google.common.truth.Truth.assertThat;

import static com.google.common.truth.Truth.assertThat;
@@ -55,6 +57,9 @@ import java.util.Optional; 




@RunWith(JUnit4.class)

@RunWith(JUnit4.class)

public class SoundTriggerMiddlewareLoggingTest {

public class SoundTriggerMiddlewareLoggingTest {

    private static final ServiceEvent.Type SERVICE_TYPE = ServiceEvent.Type.ATTACH;

    private static final SessionEvent.Type SESSION_TYPE = SessionEvent.Type.LOAD_MODEL;



    private FakeLatencyTracker mLatencyTracker;

    private FakeLatencyTracker mLatencyTracker;

    @Mock

    @Mock

    private BatteryStatsInternal mBatteryStatsInternal;

    private BatteryStatsInternal mBatteryStatsInternal;
@@ -184,4 +189,138 @@ public class SoundTriggerMiddlewareLoggingTest { 
        callback.onPhraseRecognition(0 /* modelHandle */, successEventWithKeyphraseId,

        callback.onPhraseRecognition(0 /* modelHandle */, successEventWithKeyphraseId,

                0 /* captureSession */);

                0 /* captureSession */);

    }

    }



    @Test

    public void serviceEventException_getStringContainsInfo() {

        String packageName = "com.android.test";

        Exception exception = new Exception("test");

        Object param1 = new Object();

        Object param2 = new Object();

        final var event = ServiceEvent.createForException(

                SERVICE_TYPE, packageName, exception, param1, param2);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SERVICE_TYPE.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).contains(exception.toString());

        assertThat(stringRep).contains(param1.toString());

        assertThat(stringRep).contains(param2.toString());

        assertThat(stringRep).ignoringCase().contains("error");

    }



    @Test

    public void serviceEventExceptionNoArgs_getStringContainsInfo() {

        String packageName = "com.android.test";

        Exception exception = new Exception("test");

        final var event = ServiceEvent.createForException(

                SERVICE_TYPE, packageName, exception);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SERVICE_TYPE.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).contains(exception.toString());

        assertThat(stringRep).ignoringCase().contains("error");

    }



    @Test

    public void serviceEventReturn_getStringContainsInfo() {

        String packageName = "com.android.test";

        Object param1 = new Object();

        Object param2 = new Object();

        Object retValue = new Object();

        final var event = ServiceEvent.createForReturn(

                SERVICE_TYPE, packageName, retValue, param1, param2);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SERVICE_TYPE.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).contains(retValue.toString());

        assertThat(stringRep).contains(param1.toString());

        assertThat(stringRep).contains(param2.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void serviceEventReturnNoArgs_getStringContainsInfo() {

        String packageName = "com.android.test";

        Object retValue = new Object();

        final var event = ServiceEvent.createForReturn(

                SERVICE_TYPE, packageName, retValue);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SERVICE_TYPE.name());

        assertThat(stringRep).contains(packageName);

        assertThat(stringRep).contains(retValue.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void sessionEventException_getStringContainsInfo() {

        Object param1 = new Object();

        Object param2 = new Object();

        Exception exception = new Exception("test");

        final var event = SessionEvent.createForException(

                SESSION_TYPE, exception, param1, param2);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).contains(exception.toString());

        assertThat(stringRep).contains(param1.toString());

        assertThat(stringRep).contains(param2.toString());

        assertThat(stringRep).ignoringCase().contains("error");

    }



    @Test

    public void sessionEventExceptionNoArgs_getStringContainsInfo() {

        Exception exception = new Exception("test");

        final var event = SessionEvent.createForException(

                SESSION_TYPE, exception);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).contains(exception.toString());

        assertThat(stringRep).ignoringCase().contains("error");

    }



    @Test

    public void sessionEventReturn_getStringContainsInfo() {

        Object param1 = new Object();

        Object param2 = new Object();

        Object retValue = new Object();

        final var event = SessionEvent.createForReturn(

                SESSION_TYPE, retValue, param1, param2);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).contains(retValue.toString());

        assertThat(stringRep).contains(param1.toString());

        assertThat(stringRep).contains(param2.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void sessionEventReturnNoArgs_getStringContainsInfo() {

        Object retValue = new Object();

        final var event = SessionEvent.createForReturn(

                SESSION_TYPE, retValue);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).contains(retValue.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void sessionEventVoid_getStringContainsInfo() {

        Object param1 = new Object();

        Object param2 = new Object();

        final var event = SessionEvent.createForVoid(

                SESSION_TYPE, param1, param2);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).contains(param1.toString());

        assertThat(stringRep).contains(param2.toString());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }



    @Test

    public void sessionEventVoidNoArgs_getStringContainsInfo() {

        final var event = SessionEvent.createForVoid(

                SESSION_TYPE);

        final var stringRep = event.eventToString();

        assertThat(stringRep).contains(SESSION_TYPE.name());

        assertThat(stringRep).ignoringCase().doesNotContain("error");

    }

}
 
}

services/voiceinteraction/java/com/android/server/soundtrigger/SoundTriggerEvent.java

0 → 100644
+135 −0
Original line number Original line Diff line number Diff line 
/**

 * Copyright (C) 2023 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.server.soundtrigger;



import android.util.Slog;



import com.android.server.utils.EventLogger.Event;



import java.util.UUID;



public abstract class SoundTriggerEvent extends Event {



    @Override

    public Event printLog(int type, String tag) {

        switch (type) {

            case ALOGI:

                Slog.i(tag, eventToString());

                break;

            case ALOGE:

                Slog.e(tag, eventToString());

                break;

            case ALOGW:

                Slog.w(tag, eventToString());

                break;

            case ALOGV:

            default:

                Slog.v(tag, eventToString());

        }

        return this;

    }



    public static class ServiceEvent extends SoundTriggerEvent {

        public enum Type {

            ATTACH,

            LIST_MODULE,

            DETACH,

        }



        private final Type mType;

        private final String mPackageName;

        private final String mErrorString;



        public ServiceEvent(Type type) {

            this(type, null, null);

        }



        public ServiceEvent(Type type, String packageName) {

            this(type, packageName, null);

        }



        public ServiceEvent(Type type, String packageName, String errorString) {

            mType = type;

            mPackageName = packageName;

            mErrorString = errorString;

        }



        @Override

        public String eventToString() {

            var res = new StringBuilder(String.format("%-12s", mType.name()));

            if (mErrorString != null) {

                res.append(" ERROR: ").append(mErrorString);

            }

            if (mPackageName != null) {

                res.append(" for: ").append(mPackageName);

            }

            return res.toString();

        }

    }



    public static class SessionEvent extends SoundTriggerEvent {

        public enum Type {

            // Downward calls

            START_RECOGNITION,

            STOP_RECOGNITION,

            LOAD_MODEL,

            UNLOAD_MODEL,

            UPDATE_MODEL,

            DELETE_MODEL,

            START_RECOGNITION_SERVICE,

            STOP_RECOGNITION_SERVICE,

            GET_MODEL_STATE,

            SET_PARAMETER,

            GET_MODULE_PROPERTIES,

            DETACH,

            // Callback events

            RECOGNITION,

            RESUME,

            RESUME_FAILED,

            PAUSE,

            PAUSE_FAILED,

            RESOURCES_AVAILABLE,

            MODULE_DIED

        }



        private final UUID mModelUuid;

        private final Type mType;

        private final String mErrorString;



        public SessionEvent(Type type, UUID modelUuid, String errorString) {

            mType = type;

            mModelUuid = modelUuid;

            mErrorString = errorString;

        }



        public SessionEvent(Type type, UUID modelUuid) {

            this(type, modelUuid, null);

        }



        @Override

        public String eventToString() {

            var res = new StringBuilder(String.format("%-25s", mType.name()));

            if (mErrorString != null) {

                res.append(" ERROR: ").append(mErrorString);

            }

            if (mModelUuid != null) {

                res.append(" for: ").append(mModelUuid);

            }

            return res.toString();

        }

    }

}