+ This view is strictly for debugging the Chrome App. Please take a screenshot of this view so + that we may troubleshoot further. +
+Alarms
+ ++
Enrollment Status
+ ++
OAuth Token Status
+ ++
Device ID
+ ++
App Version
+ ++
Public Key
+ ++
Client ID
+ ++
Network Connection
+ ++ + + + diff --git a/loaner/chrome_app/src/app/debug/debug.js b/loaner/chrome_app/src/app/debug/debug.js new file mode 100644 index 00000000..52b25c55 --- /dev/null +++ b/loaner/chrome_app/src/app/debug/debug.js @@ -0,0 +1,87 @@ +// Copyright 2018 Google Inc. All Rights Reserved. +// +// 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. + +/** + * Waits for the window to load and then runs the update function to populate + * debug values. + */ +window.onload = () => update(); + +/** Updates the debug view with all of the necessary debug values. */ +function update() { + // Alarms + const alarmsElement = document.getElementById('alarms'); + chrome.alarms.getAll(alarms => { + if (alarmsElement) { + alarmsElement.textContent = JSON.stringify(alarms); + } + }); + + // Loaner Storage Status + const enrollmentElement = document.getElementById('enrollment'); + chrome.storage.local.get(['loanerStatus'], status => { + if (enrollmentElement) { + enrollmentElement.textContent = JSON.stringify(status); + } + }); + + // OAuth Token + const oauthElement = document.getElementById('oauth'); + chrome.identity.getAuthToken(token => { + if (oauthElement) { + oauthElement.textContent = + token ? 'Defined' : 'THERE IS NO TOKEN DEFINED.'; + } + }); + + // Device ID + const deviceElement = document.getElementById('device'); + if (deviceElement) { + if (chrome.enterprise) { + chrome.enterprise.deviceAttributes.getDirectoryDeviceId( + id => deviceElement.textContent = id); + } else { + deviceElement.textContent = 'chrome.enterprise API is unavailable'; + } + } + + // App Version + const appVersionElement = document.getElementById('version'); + if (appVersionElement) { + appVersionElement.textContent = chrome.runtime.getManifest().version; + } + // Public Key + const keyElement = document.getElementById('key'); + if (keyElement) { + keyElement.textContent = chrome.runtime.getManifest().key; + } + + // Client ID + const clientIdElement = document.getElementById('client-id'); + if (clientIdElement) { + clientIdElement.textContent = chrome.runtime.getManifest().oauth2.client_id; + } + + // Network Connection + const networkElement = document.getElementById('network'); + if (networkElement) { + networkElement.textContent = navigator.onLine ? + 'There is a network connection.' : + 'There is NO network connection. Please connect to a WiFi network.'; + } + +} + +/** Updates the content when the refresh button is clicked. */ +document.getElementById('refresh').onclick = () => update(); diff --git a/loaner/chrome_app/src/app/manage/app.ts b/loaner/chrome_app/src/app/manage/app.ts index 53b6d401..e61ff0d8 100644 --- a/loaner/chrome_app/src/app/manage/app.ts +++ b/loaner/chrome_app/src/app/manage/app.ts @@ -13,7 +13,7 @@ // limitations under the License. import {PlatformLocation} from '@angular/common'; -import {Component, NgModule, ViewChild, ViewEncapsulation} from '@angular/core'; +import {AfterViewInit, Component, NgModule, ViewChild, ViewEncapsulation} from '@angular/core'; import {BrowserModule} from '@angular/platform-browser'; import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; import {NavigationEnd, Router, RouterModule, Routes} from '@angular/router'; @@ -21,7 +21,7 @@ import {NavigationEnd, Router, RouterModule, Routes} from '@angular/router'; import {DamagedModule} from '../../../../shared/components/damaged'; import {ExtendModule} from '../../../../shared/components/extend'; import {GuestModeModule} from '../../../../shared/components/guest'; -import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, ConfigService} from '../../../../shared/config'; +import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, CHROME_MODE, ConfigService} from '../../../../shared/config'; import {AnalyticsModule, AnalyticsService} from '../shared/analytics'; import {ChromeAppPlatformLocation,} from '../shared/chrome_app_platform_location'; import {HttpModule} from '../shared/http/http_module'; @@ -31,6 +31,7 @@ import {BottomNavModule, NavTab} from './shared/bottom_nav'; import {StatusComponent, StatusModule} from './status'; import {TroubleshootComponent, TroubleshootModule} from './troubleshoot'; +/** Represents the root management component. */ @Component({ encapsulation: ViewEncapsulation.None, preserveWhitespaces: true, @@ -38,12 +39,12 @@ import {TroubleshootComponent, TroubleshootModule} from './troubleshoot'; styleUrls: ['./app.scss'], templateUrl: './app.ng.html', }) -export class AppRoot { +export class AppRoot implements AfterViewInit { backgroundLogo = BACKGROUND_LOGO; backgroundLogoEnabled = BACKGROUND_LOGO_ENABLED; // Represents the analytics image in the body. - @ViewChild('analytics') analyticsImg!: HTMLImageElement|null; + @ViewChild('analytics', {static: true}) analyticsImg!: HTMLImageElement|null; navBarTabs: NavTab[] = [ { @@ -73,7 +74,7 @@ export class AppRoot { ) {} ngAfterViewInit() { - if (this.config.analyticsEnabled) { + if (this.config.analyticsEnabled && this.config.isAnalyticsIdValid()) { this.router.events.subscribe(route => { if (route instanceof NavigationEnd) { this.analyticsService diff --git a/loaner/chrome_app/src/app/manage/faq/faq.ts b/loaner/chrome_app/src/app/manage/faq/faq.ts index fe337df0..c596b34d 100644 --- a/loaner/chrome_app/src/app/manage/faq/faq.ts +++ b/loaner/chrome_app/src/app/manage/faq/faq.ts @@ -26,19 +26,22 @@ import * as marked from 'marked'; templateUrl: './faq.ng.html', }) export class FaqComponent implements OnInit { - sanitizedFaqContent!: string|null; + sanitizedFaqContent?: string|null; constructor( private readonly http: HttpClient, private readonly sanitizer: DomSanitizer) {} ngOnInit() { + const renderer = new marked.Renderer(); this.getFaq().subscribe((response) => { + renderer.link = (href, title, text) => + `${text}`; + marked.setOptions({renderer}); this.sanitizedFaqContent = this.sanitizer.sanitize(SecurityContext.HTML, marked(response)); }); } - /** Gets the FAQ from assets/faq.md file. */ getFaq(): Observable
{{ troubleshootingInformation }}
-
+
diff --git a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.scss b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.scss
index 89bc14bc..f3351c83 100644
--- a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.scss
+++ b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.scss
@@ -1,7 +1,3 @@
-.icon-padding {
- margin-left: 12px;
-}
-
.troubleshoot-card {
left: 50%;
text-align: center;
diff --git a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.ts b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.ts
index b0eda98c..963c8c89 100644
--- a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.ts
+++ b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot.ts
@@ -14,6 +14,7 @@
import {Component} from '@angular/core';
import {IT_CONTACT_EMAIL, IT_CONTACT_PHONE, IT_CONTACT_WEBSITE, TROUBLESHOOTING_INFORMATION} from '../../../../../shared/config';
+import {Background} from '../../shared/background_service';
@Component({
host: {
@@ -29,7 +30,7 @@ export class TroubleshootComponent {
contactWebsite?: string;
troubleshootingInformation: string;
- constructor() {
+ constructor(private readonly background: Background) {
if (IT_CONTACT_EMAIL.length > 0) {
this.contactEmail = IT_CONTACT_EMAIL;
}
@@ -49,4 +50,9 @@ export class TroubleshootComponent {
'Contact your IT department for assistance.';
}
}
+
+ /** Opens the debug view of the Chrome App. */
+ openDebugView() {
+ this.background.openView('debug', true);
+ }
}
diff --git a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot_test.ts b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot_test.ts
index ce480b5e..59496322 100644
--- a/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot_test.ts
+++ b/loaner/chrome_app/src/app/manage/troubleshoot/troubleshoot_test.ts
@@ -15,6 +15,8 @@
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {FlexLayoutModule} from '@angular/flex-layout';
+import {Background, BackgroundMock} from '../../shared/background_service';
+
import {TroubleshootComponent} from './index';
import {MaterialModule} from './material_module';
@@ -30,6 +32,7 @@ describe('TroubleshootComponent', () => {
FlexLayoutModule,
MaterialModule,
],
+ providers: [{provide: Background, useClass: BackgroundMock}],
})
.compileComponents();
});
@@ -39,11 +42,11 @@ describe('TroubleshootComponent', () => {
app = fixture.debugElement.componentInstance;
});
- it('should render content on the page', () => {
+ it('renders content on the page', () => {
expect(fixture.nativeElement.textContent).toContain('Having issues?');
});
- it('should show the contact information on the page', () => {
+ it('shows the contact information on the page', () => {
app.contactEmail = 'support@example.com';
app.contactPhone = ['12345678', '910111213'];
app.contactWebsite = 'support.example.com';
@@ -56,4 +59,13 @@ describe('TroubleshootComponent', () => {
expect(fixture.nativeElement.textContent).toContain('Contact IT');
});
+ it('opens the debug view when the button is clicked', () => {
+ const bg = TestBed.get(Background);
+ spyOn(bg, 'openView');
+ const debugButton =
+ fixture.debugElement.nativeElement.querySelector('#debug');
+ debugButton.click();
+ expect(bg.openView).toHaveBeenCalledWith('debug', true);
+ });
+
});
diff --git a/loaner/chrome_app/src/app/offboarding/app.ts b/loaner/chrome_app/src/app/offboarding/app.ts
index 21b47634..c7a69848 100644
--- a/loaner/chrome_app/src/app/offboarding/app.ts
+++ b/loaner/chrome_app/src/app/offboarding/app.ts
@@ -24,7 +24,7 @@ import {LoanerTextCardModule} from '../../../../shared/components/info_card';
import {LoanerProgressModule} from '../../../../shared/components/progress';
import {FlowsEnum, LoanerReturnInstructions, LoanerReturnInstructionsModule} from '../../../../shared/components/return_instructions';
import {Survey, SurveyAnswer, SurveyComponent, SurveyModule, SurveyType} from '../../../../shared/components/survey';
-import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, ConfigService, PROGRAM_NAME, RETURN_ANIMATION_ALT_TEXT, RETURN_ANIMATION_ENABLED, RETURN_ANIMATION_URL, TOOLBAR_ICON, TOOLBAR_ICON_ENABLED} from '../../../../shared/config';
+import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, CHROME_MODE, ConfigService, PROGRAM_NAME, RETURN_ANIMATION_ALT_TEXT, RETURN_ANIMATION_ENABLED, RETURN_ANIMATION_URL, TOOLBAR_ICON, TOOLBAR_ICON_ENABLED} from '../../../../shared/config';
import {ApiConfig, apiConfigFactory} from '../../../../shared/services/api_config';
import {NetworkService} from '../../../../shared/services/network_service';
import {AnalyticsModule, AnalyticsService} from '../shared/analytics';
@@ -85,8 +85,9 @@ export class AppRoot implements AfterViewInit, OnInit {
currentStep = 0;
maxStep = 0;
readonly steps = STEPS;
- @ViewChild(LoanerFlowSequence) flowSequence!: LoanerFlowSequence;
- @ViewChild(LoanerFlowSequenceButtons)
+ @ViewChild(LoanerFlowSequence, {static: true})
+ flowSequence!: LoanerFlowSequence;
+ @ViewChild(LoanerFlowSequenceButtons, {static: true})
flowSequenceButtons!: LoanerFlowSequenceButtons;
surveyAnswer!: SurveyAnswer;
@@ -95,12 +96,12 @@ export class AppRoot implements AfterViewInit, OnInit {
returnCompleted = false;
// Flow components to be manipulated.
- @ViewChild(SurveyComponent) surveyComponent!: SurveyComponent;
- @ViewChild(LoanerReturnInstructions)
+ @ViewChild(SurveyComponent, {static: true}) surveyComponent!: SurveyComponent;
+ @ViewChild(LoanerReturnInstructions, {static: true})
returnInstructions!: LoanerReturnInstructions;
// Represents the analytics image in the body.
- @ViewChild('analytics') analyticsImg!: HTMLImageElement|null;
+ @ViewChild('analytics', {static: true}) analyticsImg!: HTMLImageElement|null;
// Text to be populated on an info card for logout step.
logoutPage = {
@@ -138,7 +139,7 @@ device to your nearest shelf as soon as possible.`,
* @param view represents the current page/view.
*/
private updateAnalytics(view: string) {
- if (this.config.analyticsEnabled) {
+ if (this.config.analyticsEnabled && this.config.isAnalyticsIdValid()) {
this.analyticsService.sendView('offboarding', view).subscribe(url => {
if (this.analyticsImg) {
this.analyticsImg.src = window.URL.createObjectURL(url);
@@ -176,8 +177,9 @@ device to your nearest shelf as soon as possible.`,
});
// If there is no network connection, disable the flow buttons.
- this.networkService.internetStatus.subscribe(
- status => this.flowSequenceButtons.allowButtonClick = status);
+ this.networkService.internetStatus.subscribe(status => {
+ this.flowSequenceButtons.allowButtonClick = status;
+ });
// Subscribe to flow state
this.flowSequence.flowState.subscribe(state => {
@@ -279,7 +281,9 @@ experience. This will help us improve and maintain the loaner program.`;
* Handle changes from survey related items including the SurveyComponent.
*/
surveyListener() {
- this.survey.answer.subscribe(val => this.surveyAnswer = val);
+ this.survey.answer.subscribe(val => {
+ this.surveyAnswer = val;
+ });
this.surveyComponent.surveyError.subscribe(val => {
const message = `We are unable to retrieve the survey at the moment,
continue using the app as normal.`;
diff --git a/loaner/chrome_app/src/app/offboarding/app_test.ts b/loaner/chrome_app/src/app/offboarding/app_test.ts
index a875a0fc..384e82a4 100644
--- a/loaner/chrome_app/src/app/offboarding/app_test.ts
+++ b/loaner/chrome_app/src/app/offboarding/app_test.ts
@@ -96,7 +96,7 @@ describe('Offboarding AppRoot', () => {
});
it('sends survey upon request to close the application', () => {
- const surveyService: Survey = TestBed.get(Survey);
+ const surveyService = TestBed.get(Survey);
spyOn(surveyService, 'submitSurvey').and.callThrough();
const fakeSurveyData = {
more_info_text: 'Yes, this is more info.',
@@ -117,7 +117,7 @@ describe('Offboarding AppRoot', () => {
it('should close the offboarding view and NOT send the survey', () => {
expect(app.surveySent).toBeFalsy();
expect(app.surveyAnswer).toBeFalsy();
- const bg: Background = TestBed.get(Background);
+ const bg = TestBed.get(Background);
spyOn(bg, 'closeView');
app.closeApplication();
fixture.detectChanges();
diff --git a/loaner/chrome_app/src/app/offboarding/main.ts b/loaner/chrome_app/src/app/offboarding/main.ts
index aee45f49..e7748009 100644
--- a/loaner/chrome_app/src/app/offboarding/main.ts
+++ b/loaner/chrome_app/src/app/offboarding/main.ts
@@ -12,16 +12,14 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-import 'core-js/es6';
-import 'core-js/es6/array';
-import 'core-js/es6/function';
-import 'core-js/es6/map';
-import 'core-js/es6/number';
-import 'core-js/es6/object';
-import 'core-js/es6/reflect';
-import 'core-js/es6/string';
-import 'core-js/es6/symbol';
-import 'core-js/es7/reflect';
+import 'core-js/es/array';
+import 'core-js/es/function';
+import 'core-js/es/map';
+import 'core-js/es/number';
+import 'core-js/es/object';
+import 'core-js/es/string';
+import 'core-js/es/symbol';
+import 'core-js/proposals/reflect-metadata';
import 'zone.js/dist/zone';
import 'rxjs';
diff --git a/loaner/chrome_app/src/app/offboarding/material_module.ts b/loaner/chrome_app/src/app/offboarding/material_module.ts
index c87d4621..2ec439f9 100644
--- a/loaner/chrome_app/src/app/offboarding/material_module.ts
+++ b/loaner/chrome_app/src/app/offboarding/material_module.ts
@@ -13,7 +13,10 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatIconModule, MatToolbarModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatIconModule} from '@angular/material/icon';
+import {MatToolbarModule} from '@angular/material/toolbar';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES =
[MatButtonModule, MatIconModule, MatToolbarModule, MatTooltipModule];
diff --git a/loaner/chrome_app/src/app/onboarding/app.ts b/loaner/chrome_app/src/app/onboarding/app.ts
index 92f3b6fc..788ed667 100644
--- a/loaner/chrome_app/src/app/onboarding/app.ts
+++ b/loaner/chrome_app/src/app/onboarding/app.ts
@@ -17,13 +17,15 @@ import {AfterViewInit, Component, NgModule, OnInit, ViewChild, ViewEncapsulation
import {FlexLayoutModule} from '@angular/flex-layout';
import {BrowserModule, Title} from '@angular/platform-browser';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
+import {of} from 'rxjs';
+import {switchMap} from 'rxjs/operators';
import {AnimationMenuModule} from '../../../../shared/components/animation_menu';
import {FlowState, LoanerFlowSequence, LoanerFlowSequenceButtons, LoanerFlowSequenceModule, Step} from '../../../../shared/components/flow_sequence';
import {LoanerProgressModule} from '../../../../shared/components/progress';
import {FlowsEnum, LoanerReturnInstructions, LoanerReturnInstructionsModule} from '../../../../shared/components/return_instructions';
import {Survey, SurveyAnswer, SurveyComponent, SurveyModule, SurveyType} from '../../../../shared/components/survey';
-import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, ConfigService, PROGRAM_NAME, RETURN_ANIMATION_ALT_TEXT, RETURN_ANIMATION_ENABLED, RETURN_ANIMATION_URL, TOOLBAR_ICON, TOOLBAR_ICON_ENABLED} from '../../../../shared/config';
+import {BACKGROUND_LOGO, BACKGROUND_LOGO_ENABLED, CHROME_MODE, ConfigService, PROGRAM_NAME, RETURN_ANIMATION_ALT_TEXT, RETURN_ANIMATION_ENABLED, RETURN_ANIMATION_URL, TOOLBAR_ICON, TOOLBAR_ICON_ENABLED} from '../../../../shared/config';
import {ApiConfig, apiConfigFactory} from '../../../../shared/services/api_config';
import {NetworkService} from '../../../../shared/services/network_service';
import {AnalyticsModule, AnalyticsService} from '../shared/analytics';
@@ -31,6 +33,7 @@ import {Background} from '../shared/background_service';
import {ChromeAppPlatformLocation,} from '../shared/chrome_app_platform_location';
import {FailAction, FailType, Failure, FailureModule} from '../shared/failure';
import {HttpModule} from '../shared/http/http_module';
+import {Loan} from '../shared/loan';
import {ReturnDateService} from '../shared/return_date_service';
import {MaterialModule} from './material_module';
@@ -84,27 +87,30 @@ export class AppRoot implements AfterViewInit, OnInit {
currentStep = 0;
maxStep = 0;
readonly steps = STEPS;
- @ViewChild(LoanerFlowSequence) flowSequence!: LoanerFlowSequence;
- @ViewChild(LoanerFlowSequenceButtons)
+ @ViewChild(LoanerFlowSequence, {static: true})
+ flowSequence!: LoanerFlowSequence;
+ @ViewChild(LoanerFlowSequenceButtons, {static: true})
flowSequenceButtons!: LoanerFlowSequenceButtons;
surveyAnswer!: SurveyAnswer;
surveySent = false;
// Flow components to be manipulated.
- @ViewChild(WelcomeComponent) welcomeComponent!: WelcomeComponent;
- @ViewChild(SurveyComponent) surveyComponent!: SurveyComponent;
- @ViewChild(ReturnComponent) returnComponent!: ReturnComponent;
- @ViewChild(LoanerReturnInstructions)
+ @ViewChild(WelcomeComponent, {static: true})
+ welcomeComponent!: WelcomeComponent;
+ @ViewChild(SurveyComponent, {static: true}) surveyComponent!: SurveyComponent;
+ @ViewChild(ReturnComponent, {static: true}) returnComponent!: ReturnComponent;
+ @ViewChild(LoanerReturnInstructions, {static: true})
returnInstructions!: LoanerReturnInstructions;
// Represents the analytics image in the body.
- @ViewChild('analytics') analyticsImg!: HTMLImageElement|null;
+ @ViewChild('analytics', {static: true}) analyticsImg!: HTMLImageElement|null;
constructor(
private readonly analyticsService: AnalyticsService,
private readonly bg: Background,
private readonly config: ConfigService,
+ private readonly loan: Loan,
private readonly failure: Failure,
private readonly networkService: NetworkService,
private readonly returnService: ReturnDateService,
@@ -122,7 +128,7 @@ export class AppRoot implements AfterViewInit, OnInit {
* @param view represents the current page/view.
*/
private updateAnalytics(view: string) {
- if (this.config.analyticsEnabled) {
+ if (this.config.analyticsEnabled && this.config.isAnalyticsIdValid()) {
this.analyticsService.sendView('onboarding', view).subscribe(url => {
if (this.analyticsImg) {
this.analyticsImg.src = window.URL.createObjectURL(url);
@@ -155,9 +161,21 @@ export class AppRoot implements AfterViewInit, OnInit {
this.returnInstructions.animationURL = RETURN_ANIMATION_URL;
// Listen for flow finished
- this.flowSequenceButtons.finished.subscribe(finished => {
- if (finished) this.launchManageView();
- });
+ this.flowSequenceButtons.finished
+ .pipe(switchMap(finished => {
+ return finished ? this.loan.completeOnboard() : of(false);
+ }))
+ .subscribe(
+ () => {
+ this.launchManageView();
+ },
+ error => {
+ const message =
+ 'Something happened when completing the onboarding.';
+ this.failure.register(
+ message, FailType.Other, FailAction.Quit, error);
+ this.launchManageView();
+ });
// Listen for changes on the valid date observable.
this.returnService.validDate.subscribe(val => {
@@ -165,8 +183,9 @@ export class AppRoot implements AfterViewInit, OnInit {
});
// If there is no network connection, disable the flow buttons.
- this.networkService.internetStatus.subscribe(
- status => this.flowSequenceButtons.allowButtonClick = status);
+ this.networkService.internetStatus.subscribe(status => {
+ this.flowSequenceButtons.allowButtonClick = status;
+ });
// Subscribe to flow state
this.flowSequence.flowState.subscribe(state => {
@@ -280,7 +299,9 @@ ensure we have an appropriate amount of loaners.`;
* Handle changes from survey related items including the SurveyComponent.
*/
surveyListener() {
- this.survey.answer.subscribe(val => this.surveyAnswer = val);
+ this.survey.answer.subscribe(val => {
+ this.surveyAnswer = val;
+ });
this.surveyComponent.surveyError.subscribe(val => {
const message = `We are unable to retrieve the survey at the moment,
continue using the app as normal.`;
diff --git a/loaner/chrome_app/src/app/onboarding/app_test.ts b/loaner/chrome_app/src/app/onboarding/app_test.ts
index 9a741126..a8e72d37 100644
--- a/loaner/chrome_app/src/app/onboarding/app_test.ts
+++ b/loaner/chrome_app/src/app/onboarding/app_test.ts
@@ -14,6 +14,7 @@
import {HttpClientTestingModule} from '@angular/common/http/testing';
import {ComponentFixture, TestBed} from '@angular/core/testing';
+import {of} from 'rxjs';
import {AnimationMenuService} from '../../../../shared/components/animation_menu';
import {Survey, SurveyMock} from '../../../../shared/components/survey';
@@ -86,14 +87,14 @@ describe('Onboarding AppRoot', () => {
expect(app.currentStep).toBe(1);
});
- it('FAILs to go forward when canProceed is false', () => {
+ it('fails to go forward when canProceed is false', () => {
app.flowSequenceButtons.canProceed = false;
expect(app.currentStep).toBe(0);
app.flowSequenceButtons.goForward();
expect(app.currentStep).toBe(0);
});
- it('should FAIL to go forward when allowButtonClick is false', () => {
+ it('fails to go forward when allowButtonClick is false', () => {
app.flowSequenceButtons.allowButtonClick = false;
expect(app.currentStep).toBe(0);
app.flowSequenceButtons.goForward();
@@ -101,9 +102,9 @@ describe('Onboarding AppRoot', () => {
});
- it('should send survey and update surveySent value', () => {
+ it('sends survey and update surveySent value', () => {
expect(app.surveySent).toBeFalsy();
- const surveyService: Survey = TestBed.get(Survey);
+ const surveyService = TestBed.get(Survey);
spyOn(surveyService, 'submitSurvey').and.callThrough();
const fakeSurveyData = {
more_info_text: 'Yes, this is more info.',
@@ -121,10 +122,20 @@ describe('Onboarding AppRoot', () => {
expect(surveyService.submitSurvey).toHaveBeenCalledWith(fakeSurveyData);
});
- it('should open the manage view and NOT send the survey', () => {
+ it('calls completeOnboard API when finishing all steps', () => {
+ const surveyService: Survey = TestBed.get(Survey);
+ spyOn(surveyService, 'submitSurvey').and.callThrough();
+ const loan: Loan = TestBed.get(Loan);
+ spyOn(loan, 'completeOnboard').and.returnValue(of());
+ app.flowSequenceButtons.goForward();
+ app.flowSequenceButtons.finishFlow();
+ expect(loan.completeOnboard).toHaveBeenCalled();
+ });
+
+ it('opens the manage view and NOT send the survey', () => {
expect(app.surveySent).toBeFalsy();
expect(app.surveyAnswer).toBeFalsy();
- const bg: Background = TestBed.get(Background);
+ const bg = TestBed.get(Background);
spyOn(bg, 'openView');
app.launchManageView();
fixture.detectChanges();
diff --git a/loaner/chrome_app/src/app/onboarding/main.ts b/loaner/chrome_app/src/app/onboarding/main.ts
index aee45f49..e7748009 100644
--- a/loaner/chrome_app/src/app/onboarding/main.ts
+++ b/loaner/chrome_app/src/app/onboarding/main.ts
@@ -12,16 +12,14 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-import 'core-js/es6';
-import 'core-js/es6/array';
-import 'core-js/es6/function';
-import 'core-js/es6/map';
-import 'core-js/es6/number';
-import 'core-js/es6/object';
-import 'core-js/es6/reflect';
-import 'core-js/es6/string';
-import 'core-js/es6/symbol';
-import 'core-js/es7/reflect';
+import 'core-js/es/array';
+import 'core-js/es/function';
+import 'core-js/es/map';
+import 'core-js/es/number';
+import 'core-js/es/object';
+import 'core-js/es/string';
+import 'core-js/es/symbol';
+import 'core-js/proposals/reflect-metadata';
import 'zone.js/dist/zone';
import 'rxjs';
diff --git a/loaner/chrome_app/src/app/onboarding/material_module.ts b/loaner/chrome_app/src/app/onboarding/material_module.ts
index 95673c34..cbc3e1cf 100644
--- a/loaner/chrome_app/src/app/onboarding/material_module.ts
+++ b/loaner/chrome_app/src/app/onboarding/material_module.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatToolbarModule} from '@angular/material';
+import {MatToolbarModule} from '@angular/material/toolbar';
const MATERIAL_MODULES = [MatToolbarModule];
diff --git a/loaner/chrome_app/src/app/onboarding/return/material_module.ts b/loaner/chrome_app/src/app/onboarding/return/material_module.ts
index 3c503c35..564e6736 100644
--- a/loaner/chrome_app/src/app/onboarding/return/material_module.ts
+++ b/loaner/chrome_app/src/app/onboarding/return/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatCardModule, MatDatepickerModule, MatInputModule, MatNativeDateModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatNativeDateModule} from '@angular/material/core';
+import {MatDatepickerModule} from '@angular/material/datepicker';
+import {MatInputModule} from '@angular/material/input';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/chrome_app/src/app/onboarding/return/return.ng.html b/loaner/chrome_app/src/app/onboarding/return/return.ng.html
index 240620d2..91fb6242 100644
--- a/loaner/chrome_app/src/app/onboarding/return/return.ng.html
+++ b/loaner/chrome_app/src/app/onboarding/return/return.ng.html
@@ -5,10 +5,10 @@
+ Phone Support
+
- phone
-
{{ phone }}
+ E-mail Support
- email
-
{{ contactEmail }}
+ Web Support
- web
-
{{ contactWebsite }}
+
+
- Choose a return date + Choose your return date
- Please select an anticipated return date. You can always extend this later if you need to. + Please select an anticipated return date.You can always extend this later if you need to.
diff --git a/loaner/chrome_app/src/app/onboarding/return/return_test.ts b/loaner/chrome_app/src/app/onboarding/return/return_test.ts
index 7e80ae98..ed6deb32 100644
--- a/loaner/chrome_app/src/app/onboarding/return/return_test.ts
+++ b/loaner/chrome_app/src/app/onboarding/return/return_test.ts
@@ -97,7 +97,7 @@ describe('ReturnComponent', () => {
spyOn(loan, 'getDevice').and.returnValue(of(new Device(testDeviceInfo)));
app.ready();
fixture.detectChanges();
- expect(app.device.dueDate).toEqual(testDeviceInfo.due_date);
+ expect(app.device.dueDate).toEqual((testDeviceInfo.due_date!));
});
it('fails to retrieve the loan information and provides a helpful card',
diff --git a/loaner/chrome_app/src/app/onboarding/welcome/material_module.ts b/loaner/chrome_app/src/app/onboarding/welcome/material_module.ts
index 7aa4905a..17808b16 100644
--- a/loaner/chrome_app/src/app/onboarding/welcome/material_module.ts
+++ b/loaner/chrome_app/src/app/onboarding/welcome/material_module.ts
@@ -13,7 +13,10 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatCardModule, MatIconModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatIconModule} from '@angular/material/icon';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/chrome_app/src/app/onboarding/welcome/welcome.ts b/loaner/chrome_app/src/app/onboarding/welcome/welcome.ts
index b9d14c7b..a49fceb5 100644
--- a/loaner/chrome_app/src/app/onboarding/welcome/welcome.ts
+++ b/loaner/chrome_app/src/app/onboarding/welcome/welcome.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, ElementRef, OnInit, ViewChild} from '@angular/core';
-import {MatDialog} from '@angular/material';
+import {MatDialog} from '@angular/material/dialog';
import {AnimationMenuComponent} from '../../../../../shared/components/animation_menu';
import {PROGRAM_NAME, WELCOME_ANIMATATION_ALT_TEXT, WELCOME_ANIMATION_ENABLED, WELCOME_ANIMATION_URL} from '../../../../../shared/config';
@@ -26,7 +26,7 @@ import {AnimationMenuService} from '../../../../../shared/services/animation_men
templateUrl: './welcome.ng.html',
})
export class WelcomeComponent implements OnInit {
- @ViewChild('welcomeAnimation') animationElement!: ElementRef;
+ @ViewChild('welcomeAnimation', {static: false}) animationElement!: ElementRef;
playbackRate!: number;
programName: string = PROGRAM_NAME;
diff --git a/loaner/chrome_app/src/app/onboarding/welcome/welcome_test.ts b/loaner/chrome_app/src/app/onboarding/welcome/welcome_test.ts
index 15e6414e..d14e1fdd 100644
--- a/loaner/chrome_app/src/app/onboarding/welcome/welcome_test.ts
+++ b/loaner/chrome_app/src/app/onboarding/welcome/welcome_test.ts
@@ -13,8 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialog, MatDialogRef} from '@angular/material';
-import {By} from '@angular/platform-browser';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {AnimationMenuService} from '../../../../../shared/services/animation_menu_service';
import {AnimationMenuServiceMock} from '../../../../../shared/testing/mocks';
@@ -69,9 +68,10 @@ describe('WelcomeComponent', () => {
component.welcomeAnimationEnabled = true;
fixture.detectChanges();
expect(
- fixture.debugElement.query(By.css('.welcome-animation')).nativeElement)
+ fixture.debugElement.nativeElement.querySelector('.welcome-animation'))
.toBeTruthy();
- expect(fixture.debugElement.query(By.css('.welcome-card'))).toBeFalsy();
+ expect(fixture.debugElement.nativeElement.querySelector('.welcome-card'))
+ .toBeFalsy();
});
it('should have a playback rate of 100% for the welcome animation', () => {
@@ -90,17 +90,18 @@ describe('WelcomeComponent', () => {
it('should render welcome text instead of animation', () => {
component.welcomeAnimationEnabled = false;
fixture.detectChanges();
- expect(fixture.debugElement.query(By.css('.welcome-card')).nativeElement)
+ expect(fixture.debugElement.nativeElement.querySelector('.welcome-card'))
.toBeTruthy();
- expect(fixture.debugElement.query(By.css('.welcome-animation')))
+ expect(
+ fixture.debugElement.nativeElement.querySelector('.welcome-animation'))
.toBeFalsy();
});
it('should show the welcome text', () => {
component.welcomeAnimationEnabled = false;
fixture.detectChanges();
- expect(fixture.debugElement.query(By.css('.welcome-card'))
- .nativeElement.textContent)
+ expect(fixture.debugElement.nativeElement.querySelector('.welcome-card')
+ .textContent)
.toContain('Let\'s get started');
});
});
diff --git a/loaner/chrome_app/src/app/shared/analytics/analytics.ts b/loaner/chrome_app/src/app/shared/analytics/analytics.ts
index 57cbe5fb..b9ba6389 100644
--- a/loaner/chrome_app/src/app/shared/analytics/analytics.ts
+++ b/loaner/chrome_app/src/app/shared/analytics/analytics.ts
@@ -56,7 +56,8 @@ export class AnalyticsService {
return chars.join('');
}
- retrieveUuid(): Observable {
+ /** Retrieves the stored UUID or requests to generate one. */
+ retrieveUuid(): Observable<{}> {
return this.storage.local.get('analyticsID').pipe(tap(analyticsID => {
if (!analyticsID) {
const generatedId = this.generateUuid();
@@ -82,7 +83,10 @@ export class AnalyticsService {
responseType: 'blob' as 'json',
};
const structuredView = `chrome_app/${flow}${pageView}`;
- if (this.config.analyticsEnabled) {
+ const appVersion = chrome.runtime.getManifest().version ?
+ chrome.runtime.getManifest().version :
+ 'unknown';
+ if (this.config.analyticsEnabled && this.config.isAnalyticsIdValid()) {
// Confirm that cid is defined, otherwise skip it until it is defined.
return this.retrieveUuid().pipe(
skipWhile(cid => cid === undefined),
@@ -90,7 +94,8 @@ export class AnalyticsService {
cid => this.http.get(
`https://www.google-analytics.com/collect?payload_data&cid=${
cid}&dp=${structuredView}&t=pageview&tid=${
- this.config.analyticsId}&v=1`,
+ this.config.analyticsId}&v=1&an=chrome_app&av=${
+ appVersion}`,
httpOptions)));
}
return new Observable();
diff --git a/loaner/chrome_app/src/app/shared/background_service.ts b/loaner/chrome_app/src/app/shared/background_service.ts
index 77227985..e6942175 100644
--- a/loaner/chrome_app/src/app/shared/background_service.ts
+++ b/loaner/chrome_app/src/app/shared/background_service.ts
@@ -62,6 +62,7 @@ export class Background {
setAlwaysOnTop(id: string, value: boolean) {
chrome.app.window.get(id).setAlwaysOnTop(value);
}
+
}
/**
@@ -85,4 +86,5 @@ export class BackgroundMock implements Background {
setAlwaysOnTop(id: string, value: boolean) {
console.info(`Set value of alwaysOnTop for the view: ${id} to ${value}`);
}
+
}
diff --git a/loaner/chrome_app/src/app/shared/chrome_app_platform_location.ts b/loaner/chrome_app/src/app/shared/chrome_app_platform_location.ts
index 90c362aa..f2ba8246 100644
--- a/loaner/chrome_app/src/app/shared/chrome_app_platform_location.ts
+++ b/loaner/chrome_app/src/app/shared/chrome_app_platform_location.ts
@@ -13,11 +13,13 @@
// limitations under the License.
import {LocationChangeListener, PlatformLocation} from '@angular/common';
+import {Injectable} from '@angular/core';
/**
* A platform location implementation for a Chrome OS app to prevent calls
* to history.
*/
+@Injectable()
export class ChromeAppPlatformLocation extends PlatformLocation {
private appLocation: Location;
@@ -42,6 +44,22 @@ export class ChromeAppPlatformLocation extends PlatformLocation {
this.appLocation.pathname = newPath;
}
+ getState(): unknown {
+ return null;
+ }
+ get href(): string {
+ return '';
+ }
+ get protocol(): string {
+ return '';
+ }
+ get hostname(): string {
+ return '';
+ }
+ get port(): string {
+ return '';
+ }
+
getBaseHrefFromDOM() {
return '/';
}
diff --git a/loaner/chrome_app/src/app/shared/failure/failure.ts b/loaner/chrome_app/src/app/shared/failure/failure.ts
index 1af3ab45..7d8770e7 100644
--- a/loaner/chrome_app/src/app/shared/failure/failure.ts
+++ b/loaner/chrome_app/src/app/shared/failure/failure.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Inject, Injectable} from '@angular/core';
-import {MAT_DIALOG_DATA, MatDialog, MatDialogRef} from '@angular/material';
+import {MAT_DIALOG_DATA, MatDialog, MatDialogRef} from '@angular/material/dialog';
import {ConfigService, FAILURE_MESSAGE} from '../../../../../shared/config';
import {Background} from '../background_service';
diff --git a/loaner/chrome_app/src/app/shared/failure/material_module.ts b/loaner/chrome_app/src/app/shared/failure/material_module.ts
index 42998db6..882b0f47 100644
--- a/loaner/chrome_app/src/app/shared/failure/material_module.ts
+++ b/loaner/chrome_app/src/app/shared/failure/material_module.ts
@@ -13,7 +13,9 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatExpansionModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatExpansionModule} from '@angular/material/expansion';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/chrome_app/src/app/shared/http.ts b/loaner/chrome_app/src/app/shared/http.ts
index 5a82e1a6..60cb5d0d 100644
--- a/loaner/chrome_app/src/app/shared/http.ts
+++ b/loaner/chrome_app/src/app/shared/http.ts
@@ -17,15 +17,12 @@
* Note: Not a standard angular module.
*/
-import {HeaderInit} from 'node-fetch';
import {ConfigService} from '../../../../shared/config';
let accessToken: string;
const CONFIG = new ConfigService();
const MAX_RETRIES = 5;
-export type HeaderInitTs26 = HeaderInit&string[][];
-
/**
* Headers to be used in the request with oauth information
*/
@@ -42,7 +39,7 @@ function HEADERS() {
* @param headers Any other http header request information.
*/
-export function get(url: string, headers?: HeaderInitTs26) {
+export function get(url: string, headers?: HeadersInit) {
return makeRequest('get', url, undefined, headers);
}
@@ -52,7 +49,7 @@ export function get(url: string, headers?: HeaderInitTs26) {
* @param body The data to be send over the POST HTTP request
* @param headers Any other http header request information.
*/
-export function post(url: string, body: string, headers?: HeaderInitTs26) {
+export function post(url: string, body: {}, headers?: HeadersInit) {
return makeRequest('post', url, body, headers);
}
@@ -64,7 +61,7 @@ export function post(url: string, body: string, headers?: HeaderInitTs26) {
* @param headers Any other http header request information.
*/
function makeRequest(
- method: string, url: string, body?: string, headers?: HeaderInitTs26) {
+ method: string, url: string, body?: {}, headers?: HeadersInit) {
return new Promise((resolve, reject) => {
chrome.identity.getAuthToken(
{interactive: false}, (newAccessToken: string) => {
@@ -99,7 +96,7 @@ function makeRequest(
};
if (method !== 'head' && method !== 'get') {
- options.body = body || '';
+ options.body = JSON.stringify(body);
}
fetch(`${url}`, options)
diff --git a/loaner/chrome_app/src/app/shared/interfaces.d.ts b/loaner/chrome_app/src/app/shared/interfaces.d.ts
index 4d44201e..1b128f2d 100644
--- a/loaner/chrome_app/src/app/shared/interfaces.d.ts
+++ b/loaner/chrome_app/src/app/shared/interfaces.d.ts
@@ -41,3 +41,4 @@ declare interface LoanerStorage {
enrolled?: boolean;
onboardingComplete?: boolean;
}
+
diff --git a/loaner/chrome_app/src/app/shared/loan.ts b/loaner/chrome_app/src/app/shared/loan.ts
index 12d95a62..f74fa5d4 100644
--- a/loaner/chrome_app/src/app/shared/loan.ts
+++ b/loaner/chrome_app/src/app/shared/loan.ts
@@ -79,6 +79,18 @@ export class Loan {
}));
}
+ /** API request to complete onboarding. */
+ completeOnboard(): Observable {
+ let request: DeviceRequestApiParams;
+ return DeviceIdentifier.id().pipe(switchMap(deviceId => {
+ request = {
+ chrome_device_id: deviceId,
+ };
+ const apiUrl = `${this.endpointsDeviceUrl}/user/complete_onboard`;
+ return this.http.post(apiUrl, request);
+ }));
+ }
+
/** Enable guest mode for the loan. */
enableGuestMode(): Observable {
let request: DeviceRequestApiParams;
@@ -141,6 +153,10 @@ export class LoanMock {
return of(true);
}
+ completeOnboard(): Observable {
+ return of();
+ }
+
resumeLoan(): Observable {
return of(true);
}
diff --git a/loaner/chrome_app/src/app/shared/return_date_service.ts b/loaner/chrome_app/src/app/shared/return_date_service.ts
index 64743849..3fd985c7 100644
--- a/loaner/chrome_app/src/app/shared/return_date_service.ts
+++ b/loaner/chrome_app/src/app/shared/return_date_service.ts
@@ -16,6 +16,8 @@ import {Injectable} from '@angular/core';
import * as moment from 'moment';
import {BehaviorSubject, Observable} from 'rxjs';
+import {ConfigService} from '../../../../shared/config';
+
import {FailAction, FailType, Failure} from './failure';
import {Loan} from './loan';
@@ -28,7 +30,7 @@ export class ReturnDateService {
/** Formats the new requested due date via moment for API interaction. */
get formattedNewDueDate() {
- return moment(this.newReturnDate!).format(`YYYY-MM-DD[T][00]:[00]:[00]`);
+ return moment(this.newReturnDate!).format(this.config.momentLongDateFormat);
}
/** Validates the date using the new formatted due date. */
@@ -46,7 +48,11 @@ export class ReturnDateService {
validDate = this.validDateSource.asObservable();
- constructor(private readonly loan: Loan, private readonly failure: Failure) {}
+ constructor(
+ private readonly loan: Loan,
+ private readonly failure: Failure,
+ private readonly config: ConfigService,
+ ) {}
/**
* Used to update the new return date using behavior subjects.
diff --git a/loaner/chrome_app/src/app/shared/storage/storage.ts b/loaner/chrome_app/src/app/shared/storage/storage.ts
index dfbf2e96..264cfa81 100644
--- a/loaner/chrome_app/src/app/shared/storage/storage.ts
+++ b/loaner/chrome_app/src/app/shared/storage/storage.ts
@@ -18,11 +18,7 @@ import {Injectable} from '@angular/core';
import {Observable} from 'rxjs';
export declare interface Data {
- [key: string]: string;
-}
-
-export declare interface DataLoanerStorage {
- [key: string]: LoanerStorage;
+ [key: string]: {};
}
/**
@@ -50,7 +46,7 @@ export class ChromeLocalStorage {
* Retrieve a given value from chrome.storage.local.
* @param key Key for values to retrieve from storage.
*/
- get(key: string): Observable {
+ get(key: string): Observable<{}> {
return new Observable(observer => {
// Fetch initial value from local storage.
chrome.storage.local.get([key], (result: Data) => {
@@ -59,31 +55,11 @@ export class ChromeLocalStorage {
// Listen for new changes and push next in observable.
chrome.storage.onChanged.addListener((changes, namespace) => {
if (namespace === 'local' && changes[key] !== undefined) {
- observer.next(changes[key].newValue as string);
- }
- });
- });
- }
-
- /**
- * Retrieve a given value from chrome.storage.local of type LoanerStorage.
- * @param key Key for values to retrieve from storage.
- */
- getLoanerStorage(key: string): Observable {
- return new Observable(observer => {
- // Fetch initial value from local storage.
- chrome.storage.local.get([key], (result: DataLoanerStorage) => {
- observer.next(result[key]);
- });
- // Listen for new changes and push next in observable.
- chrome.storage.onChanged.addListener((changes, namespace) => {
- if (namespace === 'local' && changes[key] !== undefined) {
- observer.next(changes[key].newValue as LoanerStorage);
+ observer.next(changes[key].newValue as {});
}
});
});
}
-
/**
* Set a value at a given key location in chrome.storage.local.
* @param key Key for value to set in storage.
diff --git a/loaner/deployments/BUILD b/loaner/deployments/BUILD
index 6ea4e41c..e5663eee 100644
--- a/loaner/deployments/BUILD
+++ b/loaner/deployments/BUILD
@@ -27,10 +27,11 @@ py_binary(
srcs = [
"deploy_impl.py",
],
- default_python_version = "PY3",
+ python_version = "PY3",
srcs_version = "PY2AND3",
deps = [
":deploy_impl_lib",
+ "@six_archive//:six",
],
)
@@ -39,9 +40,11 @@ py_binary(
srcs = [
"gng_impl.py",
],
- default_python_version = "PY3",
+ python_version = "PY3",
+ srcs_version = "PY2AND3",
deps = [
":gng_impl_lib",
+ "@six_archive//:six",
],
)
@@ -97,7 +100,7 @@ py_test(
"deploy_impl_test.py",
],
deps = [
- ":deploy_impl",
+ ":deploy_impl_lib",
"@absl_archive//absl:app",
"@absl_archive//absl/flags",
"@absl_archive//absl/testing:absltest",
diff --git a/loaner/deployments/deploy.sh b/loaner/deployments/deploy.sh
index 77694b4a..a330cf2f 100755
--- a/loaner/deployments/deploy.sh
+++ b/loaner/deployments/deploy.sh
@@ -148,8 +148,8 @@ found here: https://docs.bazel.build/versions/master/install.html"
| cut -d ' ' -f3 \
| sed -E 's/(^0*|\.)//g');;
esac
- [[ "${BAZEL_VERSION}" -ge "90" ]] || error_message "The bazel vesrion \
-installed is lower than the minimum required version (0.9.0), please update \
+ [[ "${BAZEL_VERSION}" -ge "260" ]] || error_message "The bazel version \
+installed is lower than the minimum required version (0.26.0), please update \
bazel."
success_message "bazel was found on PATH and is at or above the minimum \
version."
@@ -244,7 +244,7 @@ auth login"
info_message "Initiating the build of the python deployment script..."
bazel build //loaner/deployments:deploy_impl
- ../bazel-out/k8-py3-fastbuild/bin/loaner/deployments/deploy_impl \
+ ../bazel-out/k8-fastbuild/bin/loaner/deployments/deploy_impl \
--loaner_path "$(pwd -P)" \
--app_servers "${APP_SERVERS}" \
--build_target "${BUILD_TARGET}" \
diff --git a/loaner/deployments/deploy_impl.py b/loaner/deployments/deploy_impl.py
index 07c3ed18..e91c0e64 100644
--- a/loaner/deployments/deploy_impl.py
+++ b/loaner/deployments/deploy_impl.py
@@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""The Grab n Go App Management Script.
usage: deploy_impl.py [FLAGS] [APPLICATION] [DEPLOYMENT]
@@ -49,6 +50,7 @@
from absl import flags
from absl import logging
+import six
from six.moves import input
@@ -108,6 +110,36 @@ def __init__(self, errno):
super(ManifestError, self).__init__()
+def _EnsureStr(s, encoding='utf-8', errors='strict'):
+ """Coerce *s* to `str`.
+
+ Args:
+ s: string or bytes
+ encoding: string encoding
+ errors: raise errors
+
+ Returns:
+ PY3 and PY3 str type
+
+ For Python 2:
+ - `unicode` -> encoded to `str`
+ - `str` -> `str`
+ For Python 3:
+ - `str` -> `str`
+ - `bytes` -> decoded to `str`
+ # Needs to be removed once six version is uograded to 1.12.0 or above
+ # And replace with `six.ensure_str`
+
+ """
+ if not isinstance(s, (six.text_type, six.binary_type)):
+ raise TypeError("not expecting type '%s'" % type(s))
+ if six.PY2 and isinstance(s, six.text_type):
+ s = s.encode(encoding, errors)
+ elif six.PY3 and isinstance(s, six.binary_type):
+ s = s.decode(encoding, errors)
+ return s
+
+
def _ParseAppServers(app_servers):
"""Parse the app servers for name and project id.
@@ -119,7 +151,7 @@ def _ParseAppServers(app_servers):
A dictionary with the friendly name as the key and the Google Cloud Project
ID as the value.
"""
- return dict(server.split('=', 1) for server in app_servers)
+ return dict(_EnsureStr(server).split('=', 1) for server in app_servers)
def _AppServerValidator(app_servers):
@@ -258,7 +290,7 @@ def __init__(
self._web_app_dir = web_app_dir
self._yaml_files = yaml_files
self._app_servers = _ParseAppServers(app_servers)
- if self._deployment_type not in self._app_servers.keys():
+ if self._deployment_type not in list(self._app_servers.keys()):
raise app.UsageError(
'Application name provided is not in the list of App Servers.\n'
'Please check the name and/or the deploy.sh configuration.')
@@ -292,8 +324,7 @@ def app_path(self):
@property
def app_engine_deps_path(self):
"""Retrieve the App Engine Dependencies path as a string."""
- return os.path.join(
- self.app_path, 'external', 'com_google_appengine_python')
+ return os.path.join(self.app_path, 'external', 'com_google_appengine_py')
@property
def frontend_src_path(self):
@@ -504,10 +535,8 @@ def main(argv):
# No arguments passed, show usage statement.
if len(argv) < 1:
app.usage(shorthelp=True, exitcode=1)
-
# Application to deploy: web or chrome.
application = argv[0]
-
# Server to deploy to: local, dev, or prod.
try:
deployment_type = argv[1]
diff --git a/loaner/deployments/deploy_impl_test.py b/loaner/deployments/deploy_impl_test.py
index a52264e0..415c5177 100644
--- a/loaner/deployments/deploy_impl_test.py
+++ b/loaner/deployments/deploy_impl_test.py
@@ -12,20 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""Tests for deployments.deploy_impl."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
-# Prefer Python 3 and fall back on Python 2.
-# pylint:disable=g-statement-before-imports,g-import-not-at-top
-try:
- import builtins
-except ImportError:
- import __builtin__ as builtins
-# pylint:enable=g-statement-before-imports,g-import-not-at-top
-
import datetime
import json
import subprocess
@@ -34,13 +27,21 @@
from absl import flags
from pyfakefs import fake_filesystem
from pyfakefs import fake_filesystem_shutil
-from pyfakefs import mox3_stubout
-
import freezegun
import mock
-from absl.testing import absltest
from loaner.deployments import deploy_impl
+from absl.testing import absltest
+
+# Prefer Python 3 and fall back on Python 2.
+# pylint:disable=g-statement-before-imports,g-import-not-at-top
+try:
+ import builtins
+except ImportError:
+ import six.moves.builtins as builtins
+# pylint:enable=g-statement-before-imports,g-import-not-at-top
+
+from pyfakefs import mox3_stubout
_WORKSPACE_PATH = '/this/is/a/workspace'
_LOANER_PATH = _WORKSPACE_PATH + '/loaner'
@@ -261,9 +262,8 @@ def testAppEngineServerConfigInit(self):
self.assertEndsWith(test_app_engine_config.app_path, '.runfiles/gng')
# Test that the app_engine_path ends with the bazel package name for app
# engine.
- self.assertEndsWith(
- test_app_engine_config.app_engine_deps_path,
- '.runfiles/gng/external/com_google_appengine_python')
+ self.assertEndsWith(test_app_engine_config.app_engine_deps_path,
+ '.runfiles/gng/external/com_google_appengine_py')
# Test that the frontend_src_path ends with the frontend package.
self.assertEndsWith(
test_app_engine_config.frontend_src_path,
@@ -306,7 +306,7 @@ def testBuildWebAppBackend(self, mock_execute):
"""Test that the build web application backend executes."""
fake_app_engine_deps_path = (
'/this/is/a/workspace/bazel-bin/loaner/web_app/runfiles.runfiles/gng/'
- 'external/com_google_appengine_python')
+ 'external/com_google_appengine_py')
self.fs.CreateDirectory(fake_app_engine_deps_path)
test_app_engine_config = self.CreateTestAppEngineConfig()
test_app_engine_config._BuildWebAppBackend()
@@ -451,6 +451,38 @@ def testDeployChromeApp(self, mock_buildchromeapp):
test_chrome_app_config.DeployChromeApp()
assert mock_buildchromeapp.call_count == 1
+ @mock.patch.object(
+ deploy_impl, 'AppEngineServerConfig', return_value=mock.Mock())
+ def testMainWebApp(self, mocked_appengine_server_config):
+ deploy_impl.main(argv=['first-arg', 'web'])
+ mocked_appengine_server_config.assert_called_once_with(
+ app_servers=deploy_impl.FLAGS.app_servers,
+ build_target=deploy_impl.FLAGS.build_target,
+ deployment_type='local',
+ loaner_path=deploy_impl.FLAGS.loaner_path,
+ web_app_dir=deploy_impl.FLAGS.web_app_dir,
+ yaml_files=deploy_impl.FLAGS.yaml_files,
+ version=deploy_impl.FLAGS.version)
+
+ @mock.patch.object(deploy_impl, 'ChromeAppConfig', return_value=mock.Mock())
+ def testMainChromeApp(self, mocked_chrome_app_config):
+ deploy_impl.main(argv=['first-arg', 'chrome'])
+ mocked_chrome_app_config.assert_called_once_with(
+ chrome_app_dir=deploy_impl.FLAGS.chrome_app_dir,
+ deployment_type='local',
+ loaner_path=deploy_impl.FLAGS.loaner_path)
+
+ @mock.patch.object(app, 'usage', return_value=mock.Mock())
+ def testMainWithoutParam(self, mocked_app_usage):
+ with self.assertRaises(IndexError):
+ deploy_impl.main(argv=[])
+ mocked_app_usage.assert_called_once_with(shorthelp=True, exitcode=1)
+
+ @mock.patch.object(app, 'usage', return_value=mock.Mock())
+ def testMainWithInvalidAppType(self, mocked_app_usage):
+ deploy_impl.main(argv=['first-arg', 'fake-app'])
+ mocked_app_usage.assert_called_once_with(shorthelp=True, exitcode=1)
+
if __name__ == '__main__':
absltest.main()
diff --git a/loaner/deployments/gng_impl.py b/loaner/deployments/gng_impl.py
index 4da4cc0b..0f57337c 100644
--- a/loaner/deployments/gng_impl.py
+++ b/loaner/deployments/gng_impl.py
@@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""The Grab n Go management script.
Usage: gng_impl [FLAGS]
@@ -278,7 +279,7 @@ def run(self):
utils.write('Action: {!r}\nDescription: {}\n'.format(
opt.name, opt.description))
action = utils.prompt_enum(
- '', accepted_values=self._options.keys(),
+ '', accepted_values=list(self._options.keys()),
case_sensitive=False).strip().lower()
callback = self._options[action].callback
if callback is None:
diff --git a/loaner/deployments/gng_impl_test.py b/loaner/deployments/gng_impl_test.py
index 59cfcd6c..8b102b1d 100644
--- a/loaner/deployments/gng_impl_test.py
+++ b/loaner/deployments/gng_impl_test.py
@@ -12,20 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""Tests for deployments.gng_impl."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
-# Prefer Python 2 and fall back on Python 3.
-# pylint:disable=g-statement-before-imports,g-import-not-at-top
-try:
- import __builtin__ as builtins
-except ImportError:
- import builtins
-# pylint:enable=g-statement-before-imports,g-import-not-at-top
-
import datetime
import getpass
import sys
@@ -33,24 +26,29 @@
from absl import logging
from absl.testing import flagsaver
from absl.testing import parameterized
-
from pyfakefs import fake_filesystem
-from pyfakefs import mox3_stubout
-
import freezegun
import mock
-
from six.moves import StringIO
from google.auth import credentials
-
-from absl.testing import absltest
from loaner.deployments import gng_impl
from loaner.deployments.lib import app_constants
from loaner.deployments.lib import auth
from loaner.deployments.lib import common
from loaner.deployments.lib import storage
from loaner.deployments.lib import utils
+from absl.testing import absltest
+
+# Prefer Python 2 and fall back on Python 3.
+# pylint:disable=g-statement-before-imports,g-import-not-at-top
+try:
+ import six.moves.builtins as builtins
+except ImportError:
+ import builtins
+# pylint:enable=g-statement-before-imports,g-import-not-at-top
+
+from pyfakefs import mox3_stubout
# The following constants are YAML file contents that are written to the fake
# file system.
diff --git a/loaner/deployments/lib/password_test.py b/loaner/deployments/lib/password_test.py
index 6dfe36ea..ac509c78 100644
--- a/loaner/deployments/lib/password_test.py
+++ b/loaner/deployments/lib/password_test.py
@@ -29,7 +29,7 @@ class PasswordTest(parameterized.TestCase, absltest.TestCase):
@parameterized.parameters(8, 20, 50, 70, 100)
def test_generate(self, length):
pw = password.generate(length)
- self.assertEqual(length, len(pw))
+ self.assertLen(pw, length)
@parameterized.parameters(2, 7, 101, 200)
def test_generate__value_error(self, length):
diff --git a/loaner/package.json b/loaner/package.json
index 5b079bc8..2d2590d0 100644
--- a/loaner/package.json
+++ b/loaner/package.json
@@ -1,8 +1,7 @@
{
"name": "gng",
- "version": "0.0.1",
+ "version": "1.0.0",
"license": "Apache 2.0",
- "description": "",
"scripts": {
"build:frontend": "webpack --config web_app/frontend/config/webpack.aot.js",
"start:frontend": "webpack-dev-server --port=4200 --host=0.0.0.0 --config web_app/frontend/config/webpack.aot.js",
@@ -16,79 +15,68 @@
"fix:chromeapp": "npm run lint:chromeapp:typescript -- --fix"
},
"dependencies": {
- "@angular/animations": "6.1.10",
- "@angular/cdk": "^6.1.0",
- "@angular/common": "6.1.10",
- "@angular/compiler": "6.1.10",
- "@angular/core": "6.1.10",
- "@angular/flex-layout": "6.0.0-beta.18",
- "@angular/forms": "6.1.10",
- "@angular/http": "6.1.10",
- "@angular/material": "^6.1.0",
- "@angular/platform-browser": "6.1.10",
- "@angular/platform-browser-dynamic": "6.1.10",
- "@angular/router": "6.1.10",
- "core-js": "2.5.1",
- "es6-shim": "0.35.3",
+ "@angular/animations": "8.2.14",
+ "@angular/cdk": "8.2.3",
+ "@angular/common": "8.2.14",
+ "@angular/compiler": "8.2.14",
+ "@angular/core": "8.2.14",
+ "@angular/flex-layout": "8.0.0-beta.27",
+ "@angular/forms": "8.2.14",
+ "@angular/material": "8.2.3",
+ "@angular/platform-browser": "8.2.14",
+ "@angular/platform-browser-dynamic": "8.2.14",
+ "@angular/router": "8.2.14",
+ "core-js": "3.6.4",
+ "es6-shim": "0.35.5",
"hammerjs": "2.0.8",
- "marked": "0.3.19",
+ "marked": "0.8.0",
"material-design-icons": "3.0.1",
- "moment": "2.20.1",
- "reflect-metadata": "0.1.10",
- "roboto-fontface": "0.9.0",
- "rxjs": "6.0.0",
- "zone.js": "0.8.26"
+ "moment": "2.24.0",
+ "reflect-metadata": "0.1.13",
+ "roboto-fontface": "0.10.0",
+ "rxjs": "6.5.4",
+ "zone.js": "0.10.2"
},
"devDependencies": {
- "@angular-devkit/core": "0.3.2",
- "@angular-devkit/schematics": "0.3.2",
- "@angular/cli": "7.1.3",
- "@angular/compiler-cli": "6.1.10",
- "@ngtools/webpack": "1.10.1",
- "@types/bluebird": "3.5.21",
- "@types/chrome-apps": "0.0.7",
- "@types/gapi": "0.0.35",
- "@types/gapi.auth2": "0.0.47",
- "@types/jasmine": "2.8.6",
- "@types/karma": "1.7.2",
- "@types/marked": "0.3.0",
- "@types/node": "9.4.6",
- "@types/node-fetch": "1.6.7",
+ "@angular-devkit/core": "8.3.23",
+ "@angular-devkit/schematics": "8.3.23",
+ "@angular/cli": "8.3.23",
+ "@angular/compiler-cli": "8.2.14",
+ "@ngtools/webpack": "8.3.23",
+ "@types/chrome-apps": "0.0.9",
+ "@types/gapi": "0.0.39",
+ "@types/gapi.auth2": "0.0.51",
+ "@types/jasmine": "3.5.0",
+ "@types/karma": "3.0.5",
+ "@types/marked": "0.7.2",
+ "@types/node": "13.1.7",
+ "@types/node-fetch": "2.5.4",
"angular2-template-loader": "0.6.2",
- "awesome-typescript-loader": "3.2.3",
- "babel-core": "6.25.0",
- "copy-webpack-plugin": "4.1.1",
- "css-loader": "0.28.10",
+ "awesome-typescript-loader": "5.2.1",
+ "copy-webpack-plugin": "5.1.1",
"extract-text-webpack-plugin": "3.0.2",
- "file-loader": "1.1.10",
- "html-loader": "0.5.1",
- "html-webpack-plugin": "2.30.1",
- "jasmine-core": "2.9.1",
- "json-loader": "0.5.7",
- "karma": "3.1.4",
- "karma-chrome-launcher": "2.2.0",
- "karma-coverage-istanbul-reporter": "1.3.0",
- "karma-jasmine": "1.1.0",
+ "file-loader": "5.0.2",
+ "html-loader": "0.5.5",
+ "html-webpack-plugin": "3.2.0",
+ "jasmine-core": "3.5.0",
+ "karma": "4.4.1",
+ "karma-chrome-launcher": "3.1.0",
+ "karma-jasmine": "3.1.0",
"karma-sourcemap-loader": "0.3.7",
- "karma-webpack": "3.0.5",
- "node-fetch": "2.0.0",
- "node-sass": "4.5.3",
- "node-static": "0.7.9",
- "null-loader": "0.1.1",
- "raw-loader": "0.5.1",
- "rimraf": "2.6.2",
- "sass-loader": "6.0.6",
- "style-loader": "0.20.2",
- "systemjs": "0.21.0",
- "ts-loader": "4.0.0",
- "tslint": "5.7.0",
- "tslint-eslint-rules": "5.1.0",
- "tslint-loader": "3.5.3",
- "typescript": "~2.9.2",
- "uglifyjs-webpack-plugin": "1.1.5",
- "vrsource-tslint-rules": "5.1.0",
- "webpack": "3.11.0",
- "webpack-dev-server": "3.1.10",
- "webpack-merge": "4.1.0"
+ "karma-spec-reporter": "0.0.32",
+ "karma-webpack": "4.0.2",
+ "node-sass": "4.13.1",
+ "raw-loader": "4.0.0",
+ "rimraf": "3.0.0",
+ "sass-loader": "8.0.2",
+ "svg-inline-loader": "0.8.0",
+ "terser-webpack-plugin": "2.3.2",
+ "to-string-loader": "1.1.6",
+ "tslint": "5.20.1",
+ "typescript": "3.5.3",
+ "webpack": "4.41.5",
+ "webpack-cli": "3.3.10",
+ "webpack-dev-server": "3.10.1",
+ "webpack-merge": "4.2.2"
}
}
diff --git a/loaner/shared/api_service_test.ts b/loaner/shared/api_service_test.ts
index 339c2212..8d3ef6b7 100644
--- a/loaner/shared/api_service_test.ts
+++ b/loaner/shared/api_service_test.ts
@@ -127,4 +127,62 @@ describe('ConfigService', () => {
.toBe(
'https://endpoints-dot-qa-app-engine-project.appspot.com/_ah/api');
});
+
+ it('provides the correct ID for analytics when on prod web app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = false;
+ config.ON_QA = false;
+ config.ON_PROD = true;
+ config.IS_FRONTEND = true;
+ expect(config.analyticsId).toBe('');
+ });
+
+ it('provides the correct ID for analytics when on the qa web app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = false;
+ config.ON_QA = true;
+ config.ON_PROD = false;
+ config.IS_FRONTEND = true;
+ expect(config.analyticsId).toBe('');
+ });
+
+ it('provides the correct ID for analytics when on the dev web app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = true;
+ config.ON_QA = false;
+ config.ON_PROD = false;
+ config.IS_FRONTEND = true;
+ expect(config.analyticsId).toBe('');
+ });
+
+ it('provides the correct ID for analytics when on prod chrome app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = false;
+ config.ON_QA = false;
+ config.ON_PROD = false;
+ config.IS_FRONTEND = false;
+ spyOnProperty(config, 'chromeMode', 'get')
+ .and.returnValue(CHROME_MODE.PROD);
+ expect(config.analyticsId).toBe('');
+ });
+
+ it('provides the correct ID for analytics when on the qa chrome app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = false;
+ config.ON_QA = false;
+ config.ON_PROD = false;
+ config.IS_FRONTEND = false;
+ spyOnProperty(config, 'chromeMode', 'get').and.returnValue(CHROME_MODE.QA);
+ expect(config.analyticsId).toBe('');
+ });
+
+ it('provides the correct ID for analytics when on the dev chrome app', () => {
+ config.ON_LOCAL = false;
+ config.ON_DEV = false;
+ config.ON_QA = false;
+ config.ON_PROD = false;
+ config.IS_FRONTEND = false;
+ spyOnProperty(config, 'chromeMode', 'get').and.returnValue(CHROME_MODE.DEV);
+ expect(config.analyticsId).toBe('');
+ });
});
diff --git a/loaner/shared/assets/almost_overdue.svg b/loaner/shared/assets/almost_overdue.svg
new file mode 100644
index 00000000..d91bd7a5
--- /dev/null
+++ b/loaner/shared/assets/almost_overdue.svg
@@ -0,0 +1 @@
+
diff --git a/loaner/shared/assets/gng_image.png b/loaner/shared/assets/gng_image.png
new file mode 100644
index 00000000..3bf821df
Binary files /dev/null and b/loaner/shared/assets/gng_image.png differ
diff --git a/loaner/shared/assets/healthy.svg b/loaner/shared/assets/healthy.svg
new file mode 100644
index 00000000..145f3f54
--- /dev/null
+++ b/loaner/shared/assets/healthy.svg
@@ -0,0 +1 @@
+
diff --git a/loaner/shared/assets/overdue.svg b/loaner/shared/assets/overdue.svg
new file mode 100644
index 00000000..cce2ff43
--- /dev/null
+++ b/loaner/shared/assets/overdue.svg
@@ -0,0 +1 @@
+
diff --git a/loaner/shared/components/animation_menu/animation_menu.ts b/loaner/shared/components/animation_menu/animation_menu.ts
index 5619558c..79025f15 100644
--- a/loaner/shared/components/animation_menu/animation_menu.ts
+++ b/loaner/shared/components/animation_menu/animation_menu.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component} from '@angular/core';
-import {MatDialogRef} from '@angular/material';
+import {MatDialogRef} from '@angular/material/dialog';
import {AnimationMenuService} from '../../services/animation_menu_service';
@@ -35,8 +35,9 @@ export class AnimationMenuComponent {
constructor(
private animationService: AnimationMenuService,
public dialogRef: MatDialogRef) {
- this.animationService.getAnimationSpeed().subscribe(
- speed => this.playbackRate = speed);
+ this.animationService.getAnimationSpeed().subscribe(speed => {
+ this.playbackRate = speed;
+ });
}
closeDialog() {
diff --git a/loaner/shared/components/animation_menu/animation_menu_test.ts b/loaner/shared/components/animation_menu/animation_menu_test.ts
index 1442bdf2..83312332 100644
--- a/loaner/shared/components/animation_menu/animation_menu_test.ts
+++ b/loaner/shared/components/animation_menu/animation_menu_test.ts
@@ -13,8 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogRef} from '@angular/material';
-import {By} from '@angular/platform-browser';
+import {MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {AnimationMenuService} from '../../services/animation_menu_service';
@@ -60,15 +59,15 @@ describe('AnimationMenuComponent', () => {
});
it('should show the slider', () => {
- expect(fixture.debugElement.query(By.css('.mat-dialog-title'))
- .nativeElement.innerText)
+ expect(fixture.debugElement.nativeElement.querySelector('.mat-dialog-title')
+ .innerText)
.toBe('Animation Menu');
});
it('should render the close button', () => {
fixture.detectChanges();
expect(
- fixture.debugElement.query(By.css('#close')).nativeElement.textContent)
+ fixture.debugElement.nativeElement.querySelector('#close').textContent)
.toContain('Close');
});
});
diff --git a/loaner/shared/components/animation_menu/material_module.ts b/loaner/shared/components/animation_menu/material_module.ts
index 4e5e21ac..366dc242 100644
--- a/loaner/shared/components/animation_menu/material_module.ts
+++ b/loaner/shared/components/animation_menu/material_module.ts
@@ -13,7 +13,9 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatSliderModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatSliderModule} from '@angular/material/slider';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/damaged/damaged.ts b/loaner/shared/components/damaged/damaged.ts
index 14b8ffb0..ab785f52 100644
--- a/loaner/shared/components/damaged/damaged.ts
+++ b/loaner/shared/components/damaged/damaged.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/damaged/damaged_test.ts b/loaner/shared/components/damaged/damaged_test.ts
index 28df69b1..13ad482b 100644
--- a/loaner/shared/components/damaged/damaged_test.ts
+++ b/loaner/shared/components/damaged/damaged_test.ts
@@ -15,8 +15,7 @@
import {CommonModule} from '@angular/common';
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {FormsModule} from '@angular/forms';
-import {MatDialogRef} from '@angular/material';
-import {By} from '@angular/platform-browser';
+import {MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {DamagedDialogComponent, DamagedModule} from './index';
@@ -58,29 +57,31 @@ describe('DamagedDialogComponent', () => {
it('should render the submit button', () => {
expect(
- fixture.debugElement.query(By.css('#submit')).nativeElement.textContent)
+ fixture.debugElement.nativeElement.querySelector('#submit').textContent)
.toContain('Submit');
});
it('should render the cancel button', () => {
expect(
- fixture.debugElement.query(By.css('#cancel')).nativeElement.textContent)
+ fixture.debugElement.nativeElement.querySelector('#cancel').textContent)
.toContain('Cancel');
});
it('should show the correct title', () => {
- expect(fixture.debugElement.query(By.css('.mat-dialog-title'))
- .nativeElement.innerText)
+ expect(fixture.debugElement.nativeElement.querySelector('.mat-dialog-title')
+ .innerText)
.toBe('Oh no!');
});
it('should show and hide the loader', () => {
component.waiting();
fixture.detectChanges();
- expect(fixture.debugElement.query(By.css('loader'))).toBeDefined();
+ expect(fixture.debugElement.nativeElement.querySelector('loader'))
+ .toBeDefined();
component.ready();
fixture.detectChanges();
- expect(fixture.debugElement.query(By.css('loader'))).toBeFalsy();
+ expect(fixture.debugElement.nativeElement.querySelector('loader'))
+ .toBeFalsy();
});
it('should render the close button', () => {
@@ -88,7 +89,7 @@ describe('DamagedDialogComponent', () => {
component.ready();
fixture.detectChanges();
expect(
- fixture.debugElement.query(By.css('#close')).nativeElement.textContent)
+ fixture.debugElement.nativeElement.querySelector('#close').textContent)
.toContain('Close');
});
});
diff --git a/loaner/shared/components/damaged/material_module.ts b/loaner/shared/components/damaged/material_module.ts
index 612de8fa..0fa0a307 100644
--- a/loaner/shared/components/damaged/material_module.ts
+++ b/loaner/shared/components/damaged/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatInputModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/extend/extend.ts b/loaner/shared/components/extend/extend.ts
index 48a88b26..40db0f7a 100644
--- a/loaner/shared/components/extend/extend.ts
+++ b/loaner/shared/components/extend/extend.ts
@@ -13,10 +13,11 @@
// limitations under the License.
import {Component, Injectable, OnInit} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import * as moment from 'moment';
import {Subject} from 'rxjs';
+import {ConfigService} from '../../config';
import {LoaderView} from '../loader';
/** Creates the actual dialog for the extend flow. */
@@ -70,7 +71,10 @@ export class ExtendDialogComponent extends LoaderView implements OnInit {
toBeSubmitted = true;
validDate = true;
- constructor(public dialogRef: MatDialogRef) {
+ constructor(
+ public dialogRef: MatDialogRef,
+ private readonly config: ConfigService,
+ ) {
super(false);
}
@@ -135,7 +139,7 @@ export class ExtendDialogComponent extends LoaderView implements OnInit {
extendDate() {
/** Updates the new return date to the proper API format. */
const formattedNewDueDate =
- moment(this.newReturnDate!).format(`YYYY-MM-DD[T][00]:[00]:[00]`);
+ moment(this.newReturnDate!).format(this.config.momentLongDateFormat);
if (this.validateDate(formattedNewDueDate)) {
this.loading = true;
diff --git a/loaner/shared/components/extend/extend_test.ts b/loaner/shared/components/extend/extend_test.ts
index 7f9ff365..b9073f73 100644
--- a/loaner/shared/components/extend/extend_test.ts
+++ b/loaner/shared/components/extend/extend_test.ts
@@ -13,9 +13,11 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogRef} from '@angular/material';
+import {MatDialogRef} from '@angular/material/dialog';
import * as moment from 'moment';
+import {ConfigService} from '../../config';
+
import {ExtendDialogComponent, ExtendModule} from './index';
/** Mock material DialogRef. */
@@ -25,20 +27,25 @@ describe('ExtendDialogComponent', () => {
let component: ExtendDialogComponent;
let fixture: ComponentFixture;
let compiled: HTMLElement;
+ let config: ConfigService;
beforeEach(() => {
TestBed.configureTestingModule({
imports: [
ExtendModule,
],
- providers: [{
- provide: MatDialogRef,
- useClass: MatDialogRefMock,
- }],
+ providers: [
+ {
+ provide: MatDialogRef,
+ useClass: MatDialogRefMock,
+ },
+ ConfigService
+ ],
});
fixture = TestBed.createComponent(ExtendDialogComponent);
component = fixture.debugElement.componentInstance;
+ config = TestBed.get(ConfigService);
component.dueDate = new Date(2018, 1, 1);
component.maxExtendDate = new Date(2018, 1, 2);
@@ -74,7 +81,7 @@ describe('ExtendDialogComponent', () => {
component.maxExtendDate =
moment(component.maxExtendDate).add(14, 'days').toDate();
const formattedNewDueDate =
- moment(component.newReturnDate).format(`YYYY-MM-DD[T][00]:[00]:[00]`);
+ moment(component.newReturnDate).format(config.momentLongDateFormat);
expect(component.validateDate(formattedNewDueDate)).toBe(true);
});
@@ -89,7 +96,7 @@ describe('ExtendDialogComponent', () => {
component.maxExtendDate =
moment(component.maxExtendDate).add(14, 'days').toDate();
const formattedNewDueDate =
- moment(component.newReturnDate).format(`YYYY-MM-DD[T][00]:[00]:[00]`);
+ moment(component.newReturnDate).format(config.momentLongDateFormat);
expect(component.validateDate(formattedNewDueDate)).toBe(false);
});
diff --git a/loaner/shared/components/extend/material_module.ts b/loaner/shared/components/extend/material_module.ts
index bc45d2ff..618707ae 100644
--- a/loaner/shared/components/extend/material_module.ts
+++ b/loaner/shared/components/extend/material_module.ts
@@ -13,7 +13,12 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDatepickerModule, MatDialogModule, MatInputModule, MatNativeDateModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatNativeDateModule, MatRippleModule} from '@angular/material/core';
+import {MatDatepickerModule} from '@angular/material/datepicker';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/flow_sequence/material_module.ts b/loaner/shared/components/flow_sequence/material_module.ts
index cc474b21..dcdfb58c 100644
--- a/loaner/shared/components/flow_sequence/material_module.ts
+++ b/loaner/shared/components/flow_sequence/material_module.ts
@@ -13,7 +13,9 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatIconModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatIconModule} from '@angular/material/icon';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/guest/guest.ts b/loaner/shared/components/guest/guest.ts
index f226ec6e..1762af22 100644
--- a/loaner/shared/components/guest/guest.ts
+++ b/loaner/shared/components/guest/guest.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/guest/guest_test.ts b/loaner/shared/components/guest/guest_test.ts
index 28578b61..6418913d 100644
--- a/loaner/shared/components/guest/guest_test.ts
+++ b/loaner/shared/components/guest/guest_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogModule, MatDialogRef} from '@angular/material';
+import {MatDialogModule, MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {LoaderModule} from '../loader';
diff --git a/loaner/shared/components/guest/material_module.ts b/loaner/shared/components/guest/material_module.ts
index fbe8ebec..cc6e922a 100644
--- a/loaner/shared/components/guest/material_module.ts
+++ b/loaner/shared/components/guest/material_module.ts
@@ -13,7 +13,9 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatRippleModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/info_card/material_module.ts b/loaner/shared/components/info_card/material_module.ts
index 619db599..f439f83d 100644
--- a/loaner/shared/components/info_card/material_module.ts
+++ b/loaner/shared/components/info_card/material_module.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatCardModule} from '@angular/material';
+import {MatCardModule} from '@angular/material/card';
const MATERIAL_MODULES = [MatCardModule];
diff --git a/loaner/shared/components/loan_management/greetings_card/greetings_card.scss b/loaner/shared/components/loan_management/greetings_card/greetings_card.scss
index 6b9900a8..9a85cee8 100644
--- a/loaner/shared/components/loan_management/greetings_card/greetings_card.scss
+++ b/loaner/shared/components/loan_management/greetings_card/greetings_card.scss
@@ -2,3 +2,4 @@ mat-card {
text-align: center;
width: 570px;
}
+
diff --git a/loaner/shared/components/loan_management/greetings_card/material_module.ts b/loaner/shared/components/loan_management/greetings_card/material_module.ts
index d0c82110..3bdc7944 100644
--- a/loaner/shared/components/loan_management/greetings_card/material_module.ts
+++ b/loaner/shared/components/loan_management/greetings_card/material_module.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatCardModule} from '@angular/material';
+import {MatCardModule} from '@angular/material/card';
const MATERIAL_MODULES = [
MatCardModule,
diff --git a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ng.html b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ng.html
index b2d6044b..235828b1 100644
--- a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ng.html
+++ b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ng.html
@@ -1,29 +1,47 @@
;
- /** Radio elements */
- let radioDebugElements: DebugElement[];
- let radioInstances: MatRadioButton[];
- let radioLabelElements: HTMLLabelElement[];
-
/** Test Data */
const surveyData: SurveyResponse = {
answers: [
@@ -100,12 +94,6 @@ describe('SurveyComponent', () => {
app.surveyData = surveyData;
app.ready();
fixture.detectChanges();
- radioDebugElements =
- fixture.debugElement.queryAll(By.directive(MatRadioButton));
- radioLabelElements = radioDebugElements.map(
- debugEl => debugEl.query(By.css('label')).nativeElement);
- radioInstances =
- radioDebugElements.map(debugEl => debugEl.componentInstance);
const radioButtons = fixture.nativeElement.querySelector('mat-radio-group');
for (const answer of surveyData.answers) {
expect(radioButtons.textContent).toContain(answer.text);
@@ -157,16 +145,12 @@ describe('SurveyComponent', () => {
app.surveyData = surveyData;
app.ready();
fixture.detectChanges();
- radioDebugElements =
- fixture.debugElement.queryAll(By.directive(MatRadioButton));
- radioLabelElements = radioDebugElements.map(
- debugEl => debugEl.query(By.css('label')).nativeElement);
- radioInstances =
- radioDebugElements.map(debugEl => debugEl.componentInstance);
+ const radioLabelElements =
+ fixture.debugElement.nativeElement.querySelectorAll(
+ 'mat-radio-button > label');
expect(app.surveyAnswer).not.toBeDefined();
radioLabelElements[0].click();
- expect(radioInstances[0].checked).toBeTruthy();
expect(app.surveyAnswer).toBeDefined();
fixture.detectChanges();
expect(fixture.nativeElement.textContent)
diff --git a/loaner/shared/components/survey/survey_service.ts b/loaner/shared/components/survey/survey_service.ts
index 7db76619..d4021d0c 100644
--- a/loaner/shared/components/survey/survey_service.ts
+++ b/loaner/shared/components/survey/survey_service.ts
@@ -77,7 +77,9 @@ export class Survey {
const surveyEndpoint = `${this.apiBaseUrl}/loaner/v1/survey/submit`;
return new Observable((observer) => {
this.http.post(surveyEndpoint, answer)
- .pipe(retry(2), tap(() => this.surveySent.next(true)))
+ .pipe(retry(2), tap(() => {
+ this.surveySent.next(true);
+ }))
.subscribe(
() => {
observer.next(true);
@@ -97,7 +99,9 @@ export class Survey {
const surveyEndpoint =
`${this.apiBaseUrl}/loaner/v1/survey/request?question_type=${type}`;
return this.http.get(surveyEndpoint)
- .pipe(retry(2), tap((survey) => this.retrievedSurvey = survey));
+ .pipe(retry(2), tap((survey) => {
+ this.retrievedSurvey = survey;
+ }));
}
}
diff --git a/loaner/shared/components/undamaged/material_module.ts b/loaner/shared/components/undamaged/material_module.ts
index 612de8fa..0fa0a307 100644
--- a/loaner/shared/components/undamaged/material_module.ts
+++ b/loaner/shared/components/undamaged/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatInputModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/undamaged/undamaged.ts b/loaner/shared/components/undamaged/undamaged.ts
index 81e724f7..67301646 100644
--- a/loaner/shared/components/undamaged/undamaged.ts
+++ b/loaner/shared/components/undamaged/undamaged.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/undamaged/undamaged_test.ts b/loaner/shared/components/undamaged/undamaged_test.ts
index 291a75c5..7afeb47c 100644
--- a/loaner/shared/components/undamaged/undamaged_test.ts
+++ b/loaner/shared/components/undamaged/undamaged_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogModule, MatDialogRef} from '@angular/material';
+import {MatDialogModule, MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {LoaderModule} from '../loader';
diff --git a/loaner/shared/components/unenroll/material_module.ts b/loaner/shared/components/unenroll/material_module.ts
index 612de8fa..0fa0a307 100644
--- a/loaner/shared/components/unenroll/material_module.ts
+++ b/loaner/shared/components/unenroll/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatInputModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/unenroll/unenroll.ts b/loaner/shared/components/unenroll/unenroll.ts
index cbf9fa44..de492b93 100644
--- a/loaner/shared/components/unenroll/unenroll.ts
+++ b/loaner/shared/components/unenroll/unenroll.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/unenroll/unenroll_test.ts b/loaner/shared/components/unenroll/unenroll_test.ts
index cffa5b1d..b04ceb0f 100644
--- a/loaner/shared/components/unenroll/unenroll_test.ts
+++ b/loaner/shared/components/unenroll/unenroll_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogModule, MatDialogRef} from '@angular/material';
+import {MatDialogModule, MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {LoaderModule} from '../loader';
diff --git a/loaner/shared/components/unlock/material_module.ts b/loaner/shared/components/unlock/material_module.ts
index 612de8fa..0fa0a307 100644
--- a/loaner/shared/components/unlock/material_module.ts
+++ b/loaner/shared/components/unlock/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatInputModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/unlock/unlock.ts b/loaner/shared/components/unlock/unlock.ts
index 473e73d6..e03c0693 100644
--- a/loaner/shared/components/unlock/unlock.ts
+++ b/loaner/shared/components/unlock/unlock.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/unlock/unlock_test.ts b/loaner/shared/components/unlock/unlock_test.ts
index 204e5e91..974bd150 100644
--- a/loaner/shared/components/unlock/unlock_test.ts
+++ b/loaner/shared/components/unlock/unlock_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogModule, MatDialogRef} from '@angular/material';
+import {MatDialogModule, MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {LoaderModule} from '../loader';
diff --git a/loaner/shared/config.ts b/loaner/shared/config.ts
index 3bd5caca..016b69d3 100644
--- a/loaner/shared/config.ts
+++ b/loaner/shared/config.ts
@@ -87,6 +87,16 @@ export const CHROME_PUBLIC_KEYS: EnvironmentsVariable = {
dev: '{DEV_CHROME_KEY}',
};
+/**
+ * Represents the various analytics IDs for the various release tracks an app
+ * may have.
+ */
+export const ANALYTICS_IDS: EnvironmentsVariable = {
+ prod: '',
+ qa: '',
+ dev: '',
+};
+
/** ######################################################################## */
/**
@@ -147,11 +157,12 @@ export class ConfigService {
// Shared variables
analyticsEnabled = false;
- analyticsId = '';
apiPath = '/_ah/api';
devTrack!: boolean;
private standardEndpoint!: string;
private chromeEndpoint!: string;
+ momentDueDateFormat = 'MMM Do, YYYY';
+ momentLongDateFormat = 'YYYY-MM-DD[T][00]:[00]:[00]';
// Checks what environment the app is running in.
get appMode() {
@@ -212,6 +223,21 @@ export class ConfigService {
get endpointsApiUrl(): string {
return `${this.standardEndpoint}${this.apiPath}`;
}
+
+ /** Grabs the appropriate analytics ID depending on the environment. */
+ get analyticsId(): string {
+ if (this.appMode === ENVIRONMENTS.PROD) {
+ return ANALYTICS_IDS.prod;
+ } else if (this.appMode === ENVIRONMENTS.QA) {
+ return ANALYTICS_IDS.qa;
+ }
+ return ANALYTICS_IDS.dev;
+ }
+
+ /** Check if the analytics ID for the given track is properly defined. */
+ isAnalyticsIdValid(): boolean {
+ return Boolean(this.analyticsId && this.analyticsId !== '');
+ }
}
/** Name of your Grab n Go program. */
diff --git a/loaner/shared/directives/focus/focus_test.ts b/loaner/shared/directives/focus/focus_test.ts
index dc808b59..8d292c4d 100644
--- a/loaner/shared/directives/focus/focus_test.ts
+++ b/loaner/shared/directives/focus/focus_test.ts
@@ -14,7 +14,6 @@
import {Component} from '@angular/core';
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {By} from '@angular/platform-browser';
import {FocusDirective} from './focus';
@@ -47,14 +46,14 @@ describe('FocusDirective', () => {
});
it('should focus the div with loaner-focus', () => {
- expect(
- fixture.debugElement.query(By.css('#three')).attributes['loaner-focus'])
+ expect(fixture.debugElement.nativeElement.querySelector('#three')
+ .attributes['loaner-focus'])
.toBeDefined();
});
it('should report the fourth div as not focused', () => {
- expect(
- fixture.debugElement.query(By.css('#four')).attributes['loaner-focus'])
+ expect(fixture.debugElement.nativeElement.querySelector('#four')
+ .attributes['loaner-focus'])
.toBeUndefined();
});
});
diff --git a/loaner/shared/directives/min_validator/min_validator_test.ts b/loaner/shared/directives/min_validator/min_validator_test.ts
index 575c1915..b10bb3b8 100644
--- a/loaner/shared/directives/min_validator/min_validator_test.ts
+++ b/loaner/shared/directives/min_validator/min_validator_test.ts
@@ -16,7 +16,7 @@ import {Component} from '@angular/core';
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {FormsModule} from '@angular/forms';
-import {MinValidatorModule} from '.';
+import {MinValidatorModule} from './index';
@Component({
preserveWhitespaces: true,
diff --git a/loaner/shared/directives/remove_whitespaces/remove_whitespaces_test.ts b/loaner/shared/directives/remove_whitespaces/remove_whitespaces_test.ts
index bc4df03b..6ac1e2df 100644
--- a/loaner/shared/directives/remove_whitespaces/remove_whitespaces_test.ts
+++ b/loaner/shared/directives/remove_whitespaces/remove_whitespaces_test.ts
@@ -14,7 +14,7 @@
import {Component} from '@angular/core';
import {ComponentFixture, fakeAsync, flushMicrotasks, TestBed} from '@angular/core/testing';
-import {RemoveWhitespacesModule} from '.';
+import {RemoveWhitespacesModule} from './index';
@Component({
preserveWhitespaces: true,
diff --git a/loaner/shared/directives/uppercase/uppercase_test.ts b/loaner/shared/directives/uppercase/uppercase_test.ts
index 33bb5e88..eaabb9bc 100644
--- a/loaner/shared/directives/uppercase/uppercase_test.ts
+++ b/loaner/shared/directives/uppercase/uppercase_test.ts
@@ -14,7 +14,7 @@
import {Component} from '@angular/core';
import {ComponentFixture, fakeAsync, flushMicrotasks, TestBed} from '@angular/core/testing';
-import {UppercaseModule} from '.';
+import {UppercaseModule} from './index';
@Component({
preserveWhitespaces: true,
diff --git a/loaner/shared/models/device.ts b/loaner/shared/models/device.ts
index c56597a1..2e55c3f8 100644
--- a/loaner/shared/models/device.ts
+++ b/loaner/shared/models/device.ts
@@ -16,6 +16,7 @@ import * as moment from 'moment';
import {SearchQuery} from './search';
import {Shelf, ShelfApiParams} from './shelf';
+import {TagDataParams} from './tag';
/**
* Interface with fields that come from our device API.
@@ -43,9 +44,10 @@ export declare interface DeviceApiParams {
guest_enabled?: boolean;
guest_permitted?: boolean;
page_size?: number;
- page_number?: number;
+ page_token?: string;
query?: SearchQuery;
overdue?: boolean;
+ tags?: TagDataParams[];
}
export declare interface DeviceRequestApiParams {
@@ -68,14 +70,14 @@ export declare interface MarkAsDamagedRequestApiParams {
export declare interface ListDevicesResponseApiParams {
devices: DeviceApiParams[];
- total_results: number;
- total_pages: number;
+ has_additional_results: boolean;
+ page_token: string;
}
export interface ListDevicesResponse {
devices: Device[];
- totalResults: number;
- totalPages: number;
+ has_additional_results: boolean;
+ page_token: string;
}
@@ -125,6 +127,8 @@ export class Device {
overdue = false;
/** List of flags relevant to this device. */
chips: DeviceChip[] = [];
+ /** Object with the associated tags for a given device. */
+ tags?: TagDataParams[];
constructor(device: DeviceApiParams = {}) {
this.serialNumber = device.serial_number || this.serialNumber;
@@ -150,6 +154,7 @@ export class Device {
this.givenName = device.given_name || this.givenName;
this.overdue = !!device.overdue || this.overdue;
this.chips = this.makeChips();
+ this.tags = device.tags || [];
}
/**
@@ -161,6 +166,20 @@ export class Device {
moment(this.dueDate).isBefore(this.maxExtendDate, 'day');
}
+ /**
+ * Property to determine if loan status of the device is almost overdue.
+ */
+ get isAlmostOverdue(): boolean {
+ return ((moment().diff(this.dueDate, 'days') > -1) && !this.overdue);
+ }
+
+ /**
+ * Property to determine if loan status of the device is healthy.
+ */
+ get isLoanHealthy(): boolean {
+ return !this.pendingReturn && !this.isAlmostOverdue && !this.overdue;
+ }
+
/**
* Property to calculate amount of time (in ms) until the device is due.
* A negative value indicates that the device is overdue.
@@ -182,12 +201,13 @@ export class Device {
lost: this.lost,
pending_return: this.pendingReturn,
serial_number: this.serialNumber,
- shelf: this.shelf.toApiMessage(),
+ shelf: this.shelf.location ? this.shelf.toApiMessage() : undefined,
assigned_user: this.assignedUser,
guest_enabled: this.guestEnabled,
guest_permitted: this.guestAllowed,
max_extend_date: this.maxExtendDate,
given_name: this.givenName,
+ tags: this.tags,
};
}
@@ -196,15 +216,7 @@ export class Device {
*/
private makeChips(): DeviceChip[] {
const chipsToReturn: DeviceChip[] = [];
- if (!this.assignedUser) {
- chipsToReturn.push({
- icon: 'person_outline',
- label: 'Unassigned',
- tooltip: 'This device is unassigned.',
- color: DeviceChipColor.OK,
- status: DeviceChipStatus.UNASSIGNED,
- });
- } else if (this.overdue) {
+ if (this.overdue) {
chipsToReturn.push({
icon: 'event_busy',
label: 'Overdue',
@@ -212,14 +224,6 @@ export class Device {
color: DeviceChipColor.WARNING,
status: DeviceChipStatus.OVERDUE,
});
- } else if (this.assignedUser) {
- chipsToReturn.push({
- icon: 'person',
- label: 'Assigned',
- tooltip: `This device is assigned to ${this.assignedUser}`,
- color: DeviceChipColor.PRIMARY,
- status: DeviceChipStatus.ASSIGNED,
- });
}
if (this.locked) {
chipsToReturn.push({
@@ -294,13 +298,11 @@ export enum DeviceChipColor {
}
export enum DeviceChipStatus {
- ASSIGNED = 'Assigned',
DAMAGED = 'Damaged',
LOCKED = 'Locked',
LOST = 'Lost',
PENDING_RETURN = 'Pending return',
OVERDUE = 'Overdue',
- UNASSIGNED = 'Unassigned',
}
export interface DeviceChip {
diff --git a/loaner/shared/models/shelf.ts b/loaner/shared/models/shelf.ts
index fe39a39b..be35055c 100644
--- a/loaner/shared/models/shelf.ts
+++ b/loaner/shared/models/shelf.ts
@@ -39,23 +39,27 @@ export declare interface ShelfApiParams {
responsible_for_audit?: string;
device_identifiers?: string[];
shelf_request?: ShelfRequestParams;
+ page_token?: string;
page_size?: number;
- page_number?: number;
query?: SearchQuery;
+ audit_enabled?: boolean;
}
+/** Interface of listShelfResponseApiParams. */
export declare interface ListShelfResponseApiParams {
shelves: ShelfApiParams[];
- total_results: number;
- total_pages: number;
+ has_additional_results: boolean;
+ page_token: string;
}
+/** Interface of listShelfResponse. */
export interface ListShelfResponse {
shelves: Shelf[];
- totalResults: number;
- totalPages: number;
+ has_additional_results: boolean;
+ page_token: string;
}
+/** Shelf class. */
export class Shelf {
/** The friendly name of a given shelf. */
friendlyName = '';
@@ -81,6 +85,8 @@ export class Shelf {
shelfRequest!: ShelfRequestParams;
/** Enable audit notifications. */
auditNotificationEnabled = true;
+ /** Combined status for shelf and system auditing. */
+ auditEnabled = false;
/**
* Property for the shelf name, which is preferred to be it's friendly
@@ -107,6 +113,7 @@ export class Shelf {
shelf.audit_notification_enabled === undefined ?
this.auditNotificationEnabled :
shelf.audit_notification_enabled;
+ this.auditEnabled = shelf.audit_enabled || this.auditEnabled;
}
/** Translates the Shelf model object to the API message. */
@@ -124,6 +131,7 @@ export class Shelf {
capacity: this.capacity,
shelf_request: this.shelfRequest,
audit_notification_enabled: this.auditNotificationEnabled,
+ audit_enabled: this.auditEnabled,
};
}
}
diff --git a/loaner/shared/models/tag.ts b/loaner/shared/models/tag.ts
new file mode 100644
index 00000000..2d047116
--- /dev/null
+++ b/loaner/shared/models/tag.ts
@@ -0,0 +1,106 @@
+// Copyright 2018 Google Inc. All Rights Reserved.
+//
+// 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.
+
+/** Interface with fields for the base Tag API request. */
+export declare interface TagDataParams {
+ tag?: TagApiParams;
+ more_info?: string;
+}
+
+/** Interface with fields that come from our Tag API. */
+export declare interface TagApiParams {
+ name?: string;
+ hidden?: boolean;
+ color?: string;
+ protect?: boolean;
+ description?: string;
+ urlsafe_key?: string;
+}
+
+/** Interface with fields to create a new tag. */
+export declare interface CreateTagRequest {
+ tag: TagApiParams;
+}
+
+/** Interface with fields to update a new tag. */
+export declare interface UpdateTagRequest {
+ tag: TagApiParams;
+}
+
+/** Interface with fields to get a list of tags from the backend. */
+export declare interface ListTagRequest {
+ page_size?: number;
+ cursor?: string;
+ page_index?: number;
+ include_hidden_tags?: boolean;
+}
+
+/** Interface with fields returned from a list tag request. */
+export declare interface ListTagResponseApiParams {
+ tags: TagApiParams[];
+ cursor: string;
+ has_additional_results: boolean;
+ total_pages: number;
+}
+
+/**
+ * Interface with tag objects created from the
+ * ListTagResponseApiParams returned from the backend.
+ */
+export declare interface ListTagResponse {
+ tags: Tag[];
+ cursor: string;
+ has_additional_results: boolean;
+ total_pages: number;
+}
+
+/** A Tag model with all properties and methods. */
+export class Tag {
+ /** Name of the tag. */
+ name = '';
+ /** Frontend visibility of the tag. */
+ hidden = false;
+ /** Display color for the Tag. */
+ color = '';
+ /**
+ * If the tag can be modified, associated, or disassociated from the
+ * frontend.
+ */
+ protect = false;
+ /** Description of the purpose of this tag. */
+ description = '';
+ /** Unique tag identifier generated by the backend */
+ urlSafeKey = '';
+
+ constructor(tag: TagApiParams = {}) {
+ this.name = tag.name || this.name;
+ this.hidden = tag.hidden || this.hidden;
+ this.color = tag.color || this.color;
+ this.protect = tag.protect || this.protect;
+ this.description = tag.description || this.description;
+ this.urlSafeKey = tag.urlsafe_key || this.urlSafeKey;
+ }
+
+ /** Translates the Tag model object to the API message. */
+ toApiMessage(): TagApiParams {
+ return {
+ name: this.name,
+ hidden: this.hidden,
+ color: this.color,
+ protect: this.protect,
+ description: this.description,
+ urlsafe_key: this.urlSafeKey
+ };
+ }
+}
diff --git a/loaner/shared/services/animation_menu_service.ts b/loaner/shared/services/animation_menu_service.ts
index 78e32a7a..713fbc4b 100644
--- a/loaner/shared/services/animation_menu_service.ts
+++ b/loaner/shared/services/animation_menu_service.ts
@@ -24,8 +24,8 @@ export class AnimationMenuService {
constructor() {
chrome.storage.sync.get(
'animationSpeed', (result: {[key: string]: number}) => {
- if (result.animationSpeed != null) {
- this.setAnimationSpeed(result.animationSpeed);
+ if (result['animationSpeed'] != null) {
+ this.setAnimationSpeed(result['animationSpeed']);
} else {
this.setAnimationSpeed(100);
}
diff --git a/loaner/shared/services/network_service.ts b/loaner/shared/services/network_service.ts
index ea1dd1dc..6ce333fc 100644
--- a/loaner/shared/services/network_service.ts
+++ b/loaner/shared/services/network_service.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Injectable} from '@angular/core';
-import {MatSnackBar, MatSnackBarConfig} from '@angular/material';
+import {MatSnackBar, MatSnackBarConfig} from '@angular/material/snack-bar';
import {BehaviorSubject, fromEvent} from 'rxjs';
@Injectable()
@@ -21,10 +21,12 @@ export class NetworkService {
internetStatus = new BehaviorSubject(true);
constructor(private readonly snackBar: MatSnackBar) {
- fromEvent(window, 'online')
- .subscribe(() => this.internetStatusUpdater(true));
- fromEvent(window, 'offline')
- .subscribe(() => this.internetStatusUpdater(false));
+ fromEvent(window, 'online').subscribe(() => {
+ this.internetStatusUpdater(true);
+ });
+ fromEvent(window, 'offline').subscribe(() => {
+ this.internetStatusUpdater(false);
+ });
}
/**
diff --git a/loaner/shared/testing/mocks.ts b/loaner/shared/testing/mocks.ts
index 06a457ce..53980e30 100644
--- a/loaner/shared/testing/mocks.ts
+++ b/loaner/shared/testing/mocks.ts
@@ -44,6 +44,7 @@ export abstract class DeviceActionsDialogService {
close() {}
}
+@Injectable()
export class DamagedMock extends DeviceActionsDialogService {
get onDamaged(): Observable {
return of('damagedReason');
@@ -53,12 +54,14 @@ export class DamagedMock extends DeviceActionsDialogService {
}
}
+@Injectable()
export class ExtendMock extends DeviceActionsDialogService {
get onExtended(): Observable {
return of('newDate');
}
}
+@Injectable()
export class GuestModeMock extends DeviceActionsDialogService {
get onGuestModeEnabled(): Observable {
return of(true);
@@ -71,12 +74,14 @@ export class ResumeLoanMock extends DeviceActionsDialogService {
}
}
+@Injectable()
export class LostMock extends DeviceActionsDialogService {
get onLost(): Observable {
return of(true);
}
}
+@Injectable()
export class UnenrollMock extends DeviceActionsDialogService {
get onUnenroll(): Observable {
return of(true);
@@ -114,3 +119,34 @@ export class AnimationMenuServiceMock {
return this.playbackRate.asObservable();
}
}
+
+/**
+ * Mock of the storage service to interact with the ChromeLocalStorageMock
+ * class.
+ */
+@Injectable()
+export class StorageMock {
+ private readonly chromeLocalStorageMock: ChromeLocalStorageMock;
+
+ get local() {
+ return this.chromeLocalStorageMock;
+ }
+
+ constructor() {
+ this.chromeLocalStorageMock = new ChromeLocalStorageMock();
+ }
+}
+
+/**
+ * Mocks out the ChromeLocalStorage service above since the Chrome API is not
+ * available in unit tests.
+ */
+export class ChromeLocalStorageMock {
+ get(key: string): Observable<{}> {
+ return of('Value');
+ }
+
+ set(key: string, value: {}) {
+ console.info('Setting key ', key, ' with value: ', value);
+ }
+}
diff --git a/loaner/testing/karma.conf.js b/loaner/testing/karma.conf.js
index 60a1f368..0d1c9500 100644
--- a/loaner/testing/karma.conf.js
+++ b/loaner/testing/karma.conf.js
@@ -24,17 +24,24 @@ module.exports = (config) => {
autoWatch: true,
browsers: ['ChromeHeadless'],
browserDisconnectTolerance: 3,
- browserDisconnectTimeout : 210000,
- browserNoActivityTimeout : 210000,
+ browserDisconnectTimeout: 210000,
+ browserNoActivityTimeout: 210000,
captureTimeout: 210000,
frameworks: ['jasmine'],
+ reporters: ['spec', 'progress'],
plugins: [
'karma-jasmine',
'karma-chrome-launcher',
+ 'karma-spec-reporter',
'karma-webpack',
],
files: ['./karma.entry.js'],
preprocessors: {'./karma.entry.js': ['webpack']},
singleRun: false,
+ client: {
+ jasmine: {
+ random: false,
+ }
+ },
});
};
diff --git a/loaner/testing/karma.entry.js b/loaner/testing/karma.entry.js
index 8414195e..275c9446 100644
--- a/loaner/testing/karma.entry.js
+++ b/loaner/testing/karma.entry.js
@@ -14,8 +14,9 @@
Error.stackTraceLimit = Infinity;
-require('core-js/es6');
-require('core-js/es7/reflect');
+require('core-js/es');
+require('core-js/proposals/reflect-metadata');
+require('hammerjs');
require('zone.js/dist/zone');
require('zone.js/dist/long-stack-trace-zone');
diff --git a/loaner/testing/webpack.test.js b/loaner/testing/webpack.test.js
index c2faa563..bc0a22ba 100644
--- a/loaner/testing/webpack.test.js
+++ b/loaner/testing/webpack.test.js
@@ -16,34 +16,21 @@ const webpack = require('webpack');
const helpers = require('./helpers');
module.exports = {
- resolve: {
- extensions: ['.ts', '.js'],
- modules: ['node_modules']
- },
+ mode: 'development',
+ resolve: {extensions: ['.ts', '.js'], modules: ['node_modules']},
module: {
rules: [
{
test: /\.ts$/,
- loaders: [
- 'awesome-typescript-loader',
- 'angular2-template-loader'
- ]
- },
- {
- test: /\.html$/,
- loader: 'html-loader'
+ loaders: ['awesome-typescript-loader', 'angular2-template-loader']
},
- {
- test: /\.scss$/,
- use: ["raw-loader", "sass-loader"]
- }
+ {test: /\.html$/, loader: 'html-loader'},
+ {test: /\.scss$/, use: ['to-string-loader', 'raw-loader', 'sass-loader']},
+ {test: /\.svg$/, loader: 'svg-inline-loader'}
],
},
plugins: [
new webpack.ContextReplacementPlugin(
- /angular(\\|\/)core(\\|\/)@angular/,
- helpers.root('../'),
- {}
- ),
+ /angular(\\|\/)core(\\|\/)@angular/, helpers.root('../'), {}),
]
};
diff --git a/loaner/tsconfig.json b/loaner/tsconfig.json
index 16391360..0a54f368 100644
--- a/loaner/tsconfig.json
+++ b/loaner/tsconfig.json
@@ -17,7 +17,7 @@
"lib": ["es2015", "es2016", "dom"]
},
"exclude": [
- "node_modules",
+ "node_modules"
],
"angularCompilerOptions": {
"genDir": ".",
diff --git a/loaner/web_app/BUILD b/loaner/web_app/BUILD
index 218a5b2a..5c4c3d3c 100644
--- a/loaner/web_app/BUILD
+++ b/loaner/web_app/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"py_appengine_binary",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Files
# ==============================================================================
@@ -40,7 +40,6 @@ loaner_appengine_library(
srcs = ["constants.py"],
deps = [
"//loaner/web_app/backend/models:template_model",
- "@endpoints_archive//:endpoints",
],
)
@@ -67,6 +66,7 @@ loaner_appengine_library(
"//loaner/web_app/backend/api:datastore_api",
"//loaner/web_app/backend/api:device_api",
"//loaner/web_app/backend/api:root_api",
+ "//loaner/web_app/backend/api:search_api",
"//loaner/web_app/backend/api:shelf_api",
"//loaner/web_app/backend/api:tag_api",
"//loaner/web_app/backend/api:user_api",
@@ -93,11 +93,13 @@ loaner_appengine_library(
":constants",
"//loaner/web_app/backend/handlers:frontend",
"//loaner/web_app/backend/handlers:maintenance",
+ "//loaner/web_app/backend/handlers/cron:cloud_datastore_export",
"//loaner/web_app/backend/handlers/cron:run_custom_events",
"//loaner/web_app/backend/handlers/cron:run_reminder_events",
"//loaner/web_app/backend/handlers/cron:run_shelf_audit_events",
"//loaner/web_app/backend/handlers/cron:sync_user_roles",
"//loaner/web_app/backend/handlers/task:process_action",
+ "//loaner/web_app/backend/handlers/task:process_emails",
"//loaner/web_app/backend/handlers/task:stream_to_bigquery",
],
)
diff --git a/loaner/web_app/app.yaml b/loaner/web_app/app.yaml
index 2d6c13b5..a34a93a7 100644
--- a/loaner/web_app/app.yaml
+++ b/loaner/web_app/app.yaml
@@ -65,6 +65,11 @@ handlers:
login: required
secure: always
+- url: /shared/assets
+ static_dir: loaner/web_app/frontend/src/shared/assets/
+ login: required
+ secure: always
+
- url: /style.css
static_files: loaner/web_app/frontend/src/style.css
upload: loaner/web_app/frontend/src/style\.css
diff --git a/loaner/web_app/backend/BUILD b/loaner/web_app/backend/BUILD
index aaedd6b4..d3c0c0e9 100644
--- a/loaner/web_app/backend/BUILD
+++ b/loaner/web_app/backend/BUILD
@@ -1,17 +1,17 @@
# Description:
# BUILD file for //loaner/web_app/backend.
+load(
+ "//loaner:builddefs.bzl",
+ "loaner_appengine_library",
+)
+
package(
default_visibility = [
"//loaner:__subpackages__",
],
)
-load(
- "//loaner:builddefs.bzl",
- "loaner_appengine_library",
-)
-
# ==============================================================================
# Libraries
# ==============================================================================
diff --git a/loaner/web_app/backend/actions/BUILD b/loaner/web_app/backend/actions/BUILD
index 64bd1190..cdee1ec6 100644
--- a/loaner/web_app/backend/actions/BUILD
+++ b/loaner/web_app/backend/actions/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/actions.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
diff --git a/loaner/web_app/backend/api/BUILD b/loaner/web_app/backend/api/BUILD
index fbcb8e0a..491db2ab 100644
--- a/loaner/web_app/backend/api/BUILD
+++ b/loaner/web_app/backend/api/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/api.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -32,6 +32,7 @@ loaner_appengine_library(
":shelf_api",
":survey_api",
":tag_api",
+ ":template_api",
":user_api",
],
)
@@ -44,6 +45,7 @@ loaner_appengine_library(
deps = [
"//loaner/web_app:constants",
"//loaner/web_app/backend/lib:user",
+ "//loaner/web_app/backend/models:config_model",
"//loaner/web_app/backend/models:user_model",
"@absl_archive//absl/logging",
"@endpoints_archive//:endpoints",
@@ -59,8 +61,10 @@ loaner_appengine_library(
":auth",
":permissions",
":root_api",
+ "//loaner/web_app:constants",
"//loaner/web_app/backend/api/messages:bootstrap_messages",
"//loaner/web_app/backend/lib:bootstrap",
+ "//loaner/web_app/backend/models:config_model",
],
)
@@ -122,6 +126,7 @@ loaner_appengine_library(
":root_api",
":shelf_api",
"//loaner/web_app/backend/api/messages:device_messages",
+ "//loaner/web_app/backend/clients:bigquery",
"//loaner/web_app/backend/clients:directory",
"//loaner/web_app/backend/lib:api_utils",
"//loaner/web_app/backend/lib:search_utils",
@@ -141,6 +146,7 @@ loaner_appengine_library(
data = [
"//loaner/web_app:permissions",
],
+ deps = ["@six_archive//:six"],
)
loaner_appengine_library(
@@ -227,6 +233,22 @@ loaner_appengine_library(
],
)
+loaner_appengine_library(
+ name = "template_api",
+ srcs = [
+ "template_api.py",
+ ],
+ deps = [
+ ":auth",
+ ":permissions",
+ ":root_api",
+ "//loaner/web_app/backend/api/messages:template_messages",
+ "//loaner/web_app/backend/lib:api_utils",
+ "//loaner/web_app/backend/models:template_model",
+ "@endpoints_archive//:endpoints",
+ ],
+)
+
loaner_appengine_library(
name = "user_api",
srcs = [
@@ -237,6 +259,7 @@ loaner_appengine_library(
":permissions",
":root_api",
"//loaner/web_app/backend/api/messages:user_messages",
+ "//loaner/web_app/backend/lib:api_utils",
"//loaner/web_app/backend/lib:user",
"//loaner/web_app/backend/models:user_model",
],
@@ -257,6 +280,7 @@ loaner_appengine_test(
":root_api",
"//loaner/web_app:constants",
"//loaner/web_app/backend/lib:xsrf",
+ "//loaner/web_app/backend/models:config_model",
"//loaner/web_app/backend/models:user_model",
"//loaner/web_app/backend/testing:loanertest",
"@endpoints_archive//:endpoints",
@@ -271,7 +295,9 @@ loaner_appengine_test(
],
deps = [
":bootstrap_api",
+ ":root_api",
"//loaner/web_app/backend/api/messages:bootstrap_messages",
+ "//loaner/web_app/backend/lib:bootstrap",
"//loaner/web_app/backend/testing:loanertest",
],
)
@@ -316,8 +342,9 @@ loaner_appengine_test(
],
deps = [
":datastore_api",
- "//loaner/web_app:constants",
"//loaner/web_app/backend/api/messages:bootstrap_messages",
+ "//loaner/web_app/backend/models:config_model",
+ "//loaner/web_app/backend/models:user_model",
"//loaner/web_app/backend/testing:loanertest",
],
)
@@ -330,12 +357,17 @@ loaner_appengine_test(
deps = [
":device_api",
":root_api",
+ "//loaner/web_app:constants",
"//loaner/web_app/backend/api/messages:device_messages",
"//loaner/web_app/backend/api/messages:shared_messages",
"//loaner/web_app/backend/api/messages:shelf_messages",
+ "//loaner/web_app/backend/clients:bigquery",
"//loaner/web_app/backend/clients:directory",
"//loaner/web_app/backend/lib:api_utils",
+ "//loaner/web_app/backend/lib:search_utils",
+ "//loaner/web_app/backend/models:config_model",
"//loaner/web_app/backend/models:device_model",
+ "//loaner/web_app/backend/models:shelf_model",
"//loaner/web_app/backend/testing:loanertest",
"@absl_archive//absl/testing:parameterized",
"@endpoints_archive//:endpoints",
@@ -416,6 +448,7 @@ loaner_appengine_test(
deps = [
":tag_api",
"//loaner/web_app/backend/api/messages:tag_messages",
+ "//loaner/web_app/backend/lib:api_utils",
"//loaner/web_app/backend/models:tag_model",
"//loaner/web_app/backend/testing:loanertest",
"@endpoints_archive//:endpoints",
@@ -423,6 +456,20 @@ loaner_appengine_test(
],
)
+loaner_appengine_test(
+ name = "template_api_test",
+ srcs = [
+ "template_api_test.py",
+ ],
+ deps = [
+ ":template_api",
+ "//loaner/web_app/backend/models:template_model",
+ "//loaner/web_app/backend/testing:loanertest",
+ "@absl_archive//absl/testing:parameterized",
+ "@mock_archive//:mock",
+ ],
+)
+
loaner_appengine_test(
name = "user_api_test",
srcs = [
@@ -431,6 +478,8 @@ loaner_appengine_test(
deps = [
":user_api",
"//loaner/web_app/backend/api/messages:user_messages",
+ "//loaner/web_app/backend/lib:api_utils",
+ "//loaner/web_app/backend/models:config_model",
"//loaner/web_app/backend/models:user_model",
"//loaner/web_app/backend/testing:loanertest",
],
diff --git a/loaner/web_app/backend/api/auth.py b/loaner/web_app/backend/api/auth.py
index b2194826..7a1b70b9 100644
--- a/loaner/web_app/backend/api/auth.py
+++ b/loaner/web_app/backend/api/auth.py
@@ -62,6 +62,7 @@ def do_something(self, request):
from loaner.web_app import constants
from loaner.web_app.backend.lib import user as user_lib
+from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import user_model
_FORBIDDEN_MSG = (
@@ -104,12 +105,17 @@ def wrapper(*args, **kwargs):
# Only allow domain users.
_forbid_non_domain_users(user_email)
+ datastore_user = user_model.User.get_user(user_email)
+ # If the user is not a superadmin, we need to check and see if the
+ # application is in maintenance mode.
+ if not datastore_user.superadmin:
+ _is_maintenance_mode()
+
# If there are no specified permissions, continue with the function.
if not permission:
return function_without_auth_check(*args, **kwargs)
# If there are permissions get the datastore user and compare permissions.
- datastore_user = user_model.User.get_user(user_email)
if datastore_user.superadmin or (
permission in datastore_user.get_permissions()):
return function_without_auth_check(*args, **kwargs)
@@ -135,3 +141,16 @@ def _forbid_non_domain_users(user_email):
raise endpoints.UnauthorizedException(
'{} is not an authorized user for one of the domains: {}'.format(
user_email, ', '.join(constants.APP_DOMAINS)))
+
+
+def _is_maintenance_mode():
+ """Checks to see if the application is under maintenance.
+
+ Raises:
+ endpoints.InternalServerErrorException: If the application is currently
+ under maintenance.
+ """
+ if (constants.MAINTENANCE or not
+ config_model.Config.get('bootstrap_completed')):
+ raise endpoints.InternalServerErrorException(
+ 'The application is currently undergoing maintenance.')
diff --git a/loaner/web_app/backend/api/auth_test.py b/loaner/web_app/backend/api/auth_test.py
index e757ec7d..a0ff0592 100644
--- a/loaner/web_app/backend/api/auth_test.py
+++ b/loaner/web_app/backend/api/auth_test.py
@@ -30,6 +30,7 @@
from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.api import root_api
from loaner.web_app.backend.lib import xsrf
+from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import loanertest
@@ -114,7 +115,9 @@ def test_loaner_endpoints_auth_method__unauthenticated(self):
self.call_test_as(
api_name='api_for_superadmins_only', user=user)
- def test_loaner_endpoints_auth_method__api_for_any_authenticated_user(self):
+ @mock.patch.object(config_model.Config, 'get', return_value=True)
+ def test_loaner_endpoints_auth_method__api_for_any_authenticated_user(
+ self, mock_config):
# Test api_with_permission with a user.
user = users.User(email=loanertest.USER_EMAIL)
self.assertTrue(self.call_test_as('api_for_any_authenticated_user', user))
@@ -132,7 +135,8 @@ def test_loaner_endpoints_auth_method__api_for_any_authenticated_user(self):
with self.assertRaises(endpoints.UnauthorizedException):
self.call_test_as('api_for_any_authenticated_user', user)
- def test_loaner_endpoints_auth_method__api_with_permission(self):
+ @mock.patch.object(config_model.Config, 'get', return_value=True)
+ def test_loaner_endpoints_auth_method__api_with_permission(self, mock_config):
# Forbid standard users.
user = users.User(email=loanertest.USER_EMAIL)
with self.assertRaises(endpoints.ForbiddenException):
@@ -146,7 +150,9 @@ def test_loaner_endpoints_auth_method__api_with_permission(self):
user = users.User(email=loanertest.SUPER_ADMIN_EMAIL)
self.assertTrue(self.call_test_as('api_with_permission', user))
- def test_loaner_endpoints_auth_method__api_for_superadmins_only(self):
+ @mock.patch.object(config_model.Config, 'get', return_value=True)
+ def test_loaner_endpoints_auth_method__api_for_superadmins_only(
+ self, mock_config):
# Test wrong permission.
user = users.User(email=loanertest.TECHNICAL_ADMIN_EMAIL)
with self.assertRaises(endpoints.ForbiddenException):
@@ -156,6 +162,22 @@ def test_loaner_endpoints_auth_method__api_for_superadmins_only(self):
user = users.User(email=loanertest.SUPER_ADMIN_EMAIL)
self.call_test_as('api_for_superadmins_only', user)
+ @mock.patch.object(config_model.Config, 'get', return_value=False)
+ def test_loaner_endpoints_auth_method__app_being_updated_regular_user(
+ self, mock_config):
+ with self.assertRaises(endpoints.InternalServerErrorException):
+ self.call_test_as(
+ 'api_for_any_authenticated_user',
+ users.User(email=loanertest.USER_EMAIL))
+
+ @mock.patch.object(config_model.Config, 'get', return_value=False)
+ def test_loaner_endpoints_auth_method__app_being_updated_elevated_users(
+ self, mock_config):
+ # Should execute even though the application is being updated.
+ self.assertTrue(self.call_test_as(
+ 'api_with_permission',
+ users.User(email=loanertest.SUPER_ADMIN_EMAIL)))
+
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/api/bootstrap_api.py b/loaner/web_app/backend/api/bootstrap_api.py
index 009c7a82..400a158e 100644
--- a/loaner/web_app/backend/api/bootstrap_api.py
+++ b/loaner/web_app/backend/api/bootstrap_api.py
@@ -20,11 +20,13 @@
from protorpc import message_types
+from loaner.web_app import constants
from loaner.web_app.backend.api import auth
from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.api import root_api
from loaner.web_app.backend.api.messages import bootstrap_messages
from loaner.web_app.backend.lib import bootstrap
+from loaner.web_app.backend.models import config_model
@root_api.ROOT_API.api_class(resource_name='bootstrap', path='bootstrap')
@@ -63,12 +65,9 @@ def run(self, request):
http_method='GET',
permission=permissions.Permissions.BOOTSTRAP)
def get_status(self, request):
- """Gets general bootstrap status, and task status if not yet completed."""
+ """Gets general bootstrap and bootstrap task status."""
self.check_xsrf_token(self.request_state)
response_message = bootstrap_messages.BootstrapStatusResponse()
- response_message.enabled = bootstrap.is_bootstrap_enabled()
- response_message.started = bootstrap.is_bootstrap_started()
- response_message.completed = bootstrap.is_bootstrap_completed()
for name, status in bootstrap.get_bootstrap_task_status().iteritems():
response_message.tasks.append(
bootstrap_messages.BootstrapTask(
@@ -77,4 +76,10 @@ def get_status(self, request):
success=status.get('success'),
timestamp=status.get('timestamp'),
details=status.get('details')))
+ response_message.is_update = bootstrap.is_update()
+ response_message.started = bootstrap.is_bootstrap_started()
+ response_message.completed = bootstrap.is_bootstrap_completed()
+ response_message.app_version = constants.APP_VERSION
+ response_message.running_version = config_model.Config.get(
+ 'running_version')
return response_message
diff --git a/loaner/web_app/backend/api/bootstrap_api_test.py b/loaner/web_app/backend/api/bootstrap_api_test.py
index 929367f5..0281ef5d 100644
--- a/loaner/web_app/backend/api/bootstrap_api_test.py
+++ b/loaner/web_app/backend/api/bootstrap_api_test.py
@@ -25,7 +25,9 @@
from protorpc import message_types
from loaner.web_app.backend.api import bootstrap_api
+from loaner.web_app.backend.api import root_api
from loaner.web_app.backend.api.messages import bootstrap_messages
+from loaner.web_app.backend.lib import bootstrap
from loaner.web_app.backend.testing import loanertest
@@ -34,16 +36,27 @@ class BootstrapEndpointsTest(loanertest.EndpointsTestCase):
def setUp(self):
super(BootstrapEndpointsTest, self).setUp()
-
self.service = bootstrap_api.BootstrapApi()
self.login_admin_endpoints_user()
+ self.task1_status = {
+ 'description': 'Bootstrap foo',
+ 'success': True,
+ 'timestamp': datetime.datetime.utcnow(),
+ 'details': 'Task failed'
+ }
+ self.task2_status = {
+ 'description': 'Bootstrap bar',
+ 'success': True,
+ 'timestamp': datetime.datetime.utcnow(),
+ 'details': ''}
+
def tearDown(self):
super(BootstrapEndpointsTest, self).tearDown()
self.service = None
- @mock.patch('__main__.bootstrap_api.bootstrap.run_bootstrap')
- @mock.patch('__main__.bootstrap_api.root_api.Service.check_xsrf_token')
+ @mock.patch.object(bootstrap, 'run_bootstrap', autospec=True)
+ @mock.patch.object(root_api.Service, 'check_xsrf_token', autospec=True)
def test_run(self, mock_xsrf_token, mock_runbootstrap):
"""Test bootstrap init."""
mock_runbootstrap.return_value = {
@@ -64,7 +77,7 @@ def test_run(self, mock_xsrf_token, mock_runbootstrap):
request.requested_tasks = [task1, task2]
response = self.service.run(request)
- self.assertTrue(mock_runbootstrap.called)
+ self.assertEqual(mock_runbootstrap.call_count, 1)
self.assertEqual(mock_xsrf_token.call_count, 1)
self.assertCountEqual(
['task1', 'task2'], [task.name for task in response.tasks])
@@ -72,92 +85,35 @@ def test_run(self, mock_xsrf_token, mock_runbootstrap):
['Running a task.', 'Running another task'],
[task.description for task in response.tasks])
- @mock.patch(
- '__main__.bootstrap_api.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap_api.bootstrap.get_bootstrap_task_status')
- @mock.patch('__main__.bootstrap_api.bootstrap.is_bootstrap_enabled')
- @mock.patch('__main__.bootstrap_api.bootstrap.is_bootstrap_started')
- @mock.patch('__main__.bootstrap_api.bootstrap.is_bootstrap_completed')
- @mock.patch('__main__.bootstrap_api.root_api.Service.check_xsrf_token')
+ @mock.patch.object(bootstrap, 'get_bootstrap_task_status', autospec=True)
+ @mock.patch.object(
+ bootstrap, 'is_bootstrap_started', autospec=True, return_value=True)
+ @mock.patch.object(
+ bootstrap, 'is_bootstrap_completed', autospec=True, return_value=True)
+ @mock.patch.object(bootstrap, 'is_update', autospec=True, return_value=False)
+ @mock.patch.object(root_api.Service, 'check_xsrf_token', autospec=True)
def test_get_status(
- self, mock_xsrf_token, mock_is_completed, mock_is_started,
- mock_is_enabled, mock_get_task_status):
+ self, mock_xsrf_token, mock_is_update, mock_is_completed,
+ mock_is_started, mock_get_task_status):
"""Tests get_status for general status and task details."""
- yesterday = datetime.datetime.utcnow() - datetime.timedelta(days=-1)
- task1_status = {
- 'description': 'Bootstrap foo',
- 'success': False,
- 'timestamp': yesterday,
- 'details': 'Task failed'
- }
- task2_status = {
- 'description': 'Bootstrap bar',
- 'success': True,
- 'timestamp': yesterday,
- 'details': ''}
mock_get_task_status.return_value = {
- 'task1': task1_status,
- 'task2': task2_status
+ 'task1': self.task1_status,
+ 'task2': self.task2_status
}
- mock_is_started.return_value = True
- request = message_types.VoidMessage()
- mock_is_enabled.return_value = True
- mock_is_completed.return_value = True
+ request = message_types.VoidMessage()
response = self.service.get_status(request)
- self.assertTrue(response.enabled)
self.assertTrue(response.started)
self.assertTrue(response.completed)
+ self.assertFalse(response.is_update)
+ self.assertEqual(response.running_version, '0.0')
+ self.assertEqual(response.app_version, bootstrap_api.constants.APP_VERSION)
+ for task in response.tasks:
+ self.assertTrue(task.success)
self.assertEqual(mock_xsrf_token.call_count, 1)
-
mock_xsrf_token.reset_mock()
- # Enabled False and completed True, so no tasks in response.
- mock_is_enabled.return_value = False
- mock_is_completed.return_value = True
- response = self.service.get_status(request)
-
- self.assertFalse(response.enabled)
- self.assertTrue(response.completed)
- self.assertEqual(mock_xsrf_token.call_count, 1)
-
- mock_xsrf_token.reset_mock()
-
- # Enabled True and completed False, so yes tasks in response.
- mock_is_enabled.return_value = True
- mock_is_completed.return_value = False
- response = self.service.get_status(request)
-
- self.assertTrue(response.enabled)
- self.assertFalse(response.completed)
- self.assertEqual(mock_xsrf_token.call_count, 1)
-
- task1_success = [
- task.success for task in response.tasks if task.name == 'task1'][0]
- task2_success = [
- task.success for task in response.tasks if task.name == 'task2'][0]
- self.assertFalse(task1_success)
- self.assertTrue(task2_success)
-
- mock_xsrf_token.reset_mock()
-
- # Enabled False and completed False, so yes tasks in response.
- mock_is_enabled.return_value = False
- mock_is_completed.return_value = False
- response = self.service.get_status(request)
-
- self.assertFalse(response.enabled)
- self.assertFalse(response.completed)
- self.assertEqual(mock_xsrf_token.call_count, 1)
-
- task1_success = [
- task.success for task in response.tasks if task.name == 'task1'][0]
- task2_success = [
- task.success for task in response.tasks if task.name == 'task2'][0]
- self.assertFalse(task1_success)
- self.assertTrue(task2_success)
-
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/api/chrome_api.py b/loaner/web_app/backend/api/chrome_api.py
index 8e53ca60..88bf5400 100644
--- a/loaner/web_app/backend/api/chrome_api.py
+++ b/loaner/web_app/backend/api/chrome_api.py
@@ -54,10 +54,13 @@ def heartbeat(self, request):
if device.enrolled:
is_enrolled = True
if device.assigned_user == user_email:
- device.loan_resumes_if_late(user_email)
+ if device.onboarded:
+ device.loan_resumes_if_late(user_email)
+ else:
+ start_assignment = True
else:
- start_assignment = True
device.loan_assign(user_email)
+ start_assignment = True
else:
try:
diff --git a/loaner/web_app/backend/api/chrome_api_test.py b/loaner/web_app/backend/api/chrome_api_test.py
index 560e9350..092ee969 100644
--- a/loaner/web_app/backend/api/chrome_api_test.py
+++ b/loaner/web_app/backend/api/chrome_api_test.py
@@ -47,12 +47,15 @@ def setUp(self):
self.login_endpoints_user()
self.chrome_request = chrome_messages.HeartbeatRequest(device_id=UNIQUE_ID)
config_model.Config(id='silent_onboarding', bool_value=False).put()
+ # Set bootstrap to completed so that maintenance mode will not be invoked.
+ config_model.Config.set('bootstrap_completed', True)
def tearDown(self):
super(ChromeEndpointsTest, self).tearDown()
self.service = None
- def create_device(self, enrolled=True, assigned_user=None, asset_tag=None):
+ def create_device(self, enrolled=True, assigned_user=None, asset_tag=None,
+ onboarded=None):
loan_resumes_if_late_patcher = mock.patch.object(
device_model.Device, 'loan_resumes_if_late')
loan_resumes_if_late_patcher.start()
@@ -62,7 +65,8 @@ def create_device(self, enrolled=True, assigned_user=None, asset_tag=None):
enrolled=enrolled,
device_model='HP Chromebook 13 G1',
current_ou='/',
- chrome_device_id=UNIQUE_ID)
+ chrome_device_id=UNIQUE_ID,
+ onboarded=onboarded)
self.device.put()
self.mock_loan_resumes_if_late = self.device.loan_resumes_if_late
@@ -105,7 +109,7 @@ def test_heartbeat_assigned_device(self):
def test_heartbeat_assignment_unchanged(self):
"""Tests heartbeat processing for an unchanged assignment."""
- self.create_device(assigned_user=loanertest.USER_EMAIL)
+ self.create_device(assigned_user=loanertest.USER_EMAIL, onboarded=True)
response = self.service.heartbeat(self.chrome_request)
self.assertIsInstance(response, chrome_messages.HeartbeatResponse)
diff --git a/loaner/web_app/backend/api/datastore_api_test.py b/loaner/web_app/backend/api/datastore_api_test.py
index 269f2c02..08af014b 100644
--- a/loaner/web_app/backend/api/datastore_api_test.py
+++ b/loaner/web_app/backend/api/datastore_api_test.py
@@ -24,6 +24,7 @@
from loaner.web_app.backend.api import datastore_api
from loaner.web_app.backend.api.messages import datastore_messages
+from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import loanertest
@@ -34,6 +35,8 @@ class DatastoreEndpointsTest(loanertest.EndpointsTestCase):
def setUp(self):
super(DatastoreEndpointsTest, self).setUp()
self.service = datastore_api.DatastoreApi()
+ # Set bootstrap to completed so that maintenance mode will not be invoked.
+ config_model.Config.set('bootstrap_completed', True)
def tearDown(self):
super(DatastoreEndpointsTest, self).tearDown()
diff --git a/loaner/web_app/backend/api/device_api.py b/loaner/web_app/backend/api/device_api.py
index e85e2458..24a1094e 100644
--- a/loaner/web_app/backend/api/device_api.py
+++ b/loaner/web_app/backend/api/device_api.py
@@ -22,13 +22,12 @@
from google.appengine.api import datastore_errors
-import endpoints
-
from loaner.web_app.backend.api import auth
from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.api import root_api
from loaner.web_app.backend.api import shelf_api
from loaner.web_app.backend.api.messages import device_messages
+from loaner.web_app.backend.clients import bigquery
from loaner.web_app.backend.clients import directory
from loaner.web_app.backend.lib import api_utils
from loaner.web_app.backend.lib import search_utils
@@ -36,10 +35,12 @@
from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import device_model
from loaner.web_app.backend.models import user_model
+import endpoints
+# pylint:disable=g-import-not-at-top,g-bad-import-order,reimported
+from loaner.web_app import constants
-_NO_DEVICE_MSG = (
- 'Device could not be found using device_identifier "%s".')
+_NO_DEVICE_MSG = ('Device could not be found using device_identifier "%s".')
_NO_IDENTIFIERS_MSG = 'No identifier supplied to find device.'
_BAD_URLKEY_MSG = 'No device found because the URL-safe key was invalid: %s'
_LIST_DEVICES_USER_MISMATCH_MSG = (
@@ -68,9 +69,8 @@ def enroll(self, request):
asset_tag=request.asset_tag,
serial_number=request.serial_number,
user_email=user_email)
- except (
- datastore_errors.BadValueError,
- device_model.DeviceCreationError) as error:
+ except (datastore_errors.BadValueError,
+ device_model.DeviceCreationError) as error:
raise endpoints.BadRequestException(str(error))
return message_types.VoidMessage()
@@ -106,9 +106,8 @@ def unlock(self, request):
user_email = user_lib.get_user_email()
try:
device.unlock(user_email)
- except (
- directory.DirectoryRPCError,
- device_model.UnableToMoveToDefaultOUError) as error:
+ except (directory.DirectoryRPCError,
+ device_model.UnableToMoveToDefaultOUError) as error:
raise endpoints.BadRequestException(str(error))
return message_types.VoidMessage()
@@ -125,9 +124,9 @@ def device_audit_check(self, request):
device = _get_device(request)
try:
device.device_audit_check()
- except (
- device_model.DeviceNotEnrolledError,
- device_model.UnableToMoveToShelfError) as err:
+ except (device_model.DeviceNotEnrolledError,
+ device_model.UnableToMoveToShelfError,
+ device_model.DeviceAuditEventError) as err:
raise endpoints.BadRequestException(str(err))
return message_types.VoidMessage()
@@ -141,8 +140,8 @@ def get_device(self, request):
"""Gets a device using any identifier in device_messages.DeviceRequest."""
device = _get_device(request)
if not device.enrolled:
- raise endpoints.BadRequestException(
- device_model.DEVICE_NOT_ENROLLED_MSG % device.identifier)
+ raise endpoints.BadRequestException(device_model.DEVICE_NOT_ENROLLED_MSG %
+ device.identifier)
user_email = user_lib.get_user_email()
datastore_user = user_model.User.get_user(user_email)
if (permissions.Permissions.READ_DEVICES not in
@@ -155,8 +154,7 @@ def get_device(self, request):
directory_client = directory.DirectoryApiClient(user_email)
try:
given_name = directory_client.given_name(user_email)
- except (
- directory.DirectoryRPCError, directory.GivenNameDoesNotExistError):
+ except (directory.DirectoryRPCError, directory.GivenNameDoesNotExistError):
given_name = None
message = api_utils.build_device_message_from_model(
device, config_model.Config.get('allow_guest_mode'))
@@ -173,9 +171,6 @@ def get_device(self, request):
def list_devices(self, request):
"""Lists all devices based on any device attribute."""
self.check_xsrf_token(self.request_state)
- if request.page_size <= 0:
- raise endpoints.BadRequestException(
- 'The value for page_size must be greater than 0.')
query, sort_options, returned_fields = (
search_utils.set_search_query_options(request.query))
if not query:
@@ -190,27 +185,31 @@ def list_devices(self, request):
query = search_utils.to_query(request, device_model.Device)
query = ' '.join((query, shelf_query))
- offset = search_utils.calculate_page_offset(
- page_size=request.page_size, page_number=request.page_number)
+ cursor = search_utils.get_search_cursor(request.page_token)
search_results = device_model.Device.search(
- query_string=query, query_limit=request.page_size,
- offset=offset, sort_options=sort_options,
+ query_string=query,
+ query_limit=request.page_size,
+ cursor=cursor,
+ sort_options=sort_options,
returned_fields=returned_fields)
- total_pages = search_utils.calculate_total_pages(
- page_size=request.page_size, total_results=search_results.number_found)
+ new_search_cursor = None
+ if search_results.cursor:
+ new_search_cursor = search_results.cursor.web_safe_string
guest_permitted = config_model.Config.get('allow_guest_mode')
messages = []
for document in search_results.results:
message = search_utils.document_to_message(
document, device_messages.Device())
message.guest_permitted = guest_permitted
+ if message.current_ou == constants.ORG_UNIT_DICT['GUEST']:
+ message.guest_enabled = True
messages.append(message)
return device_messages.ListDevicesResponse(
devices=messages,
- total_results=search_results.number_found,
- total_pages=total_pages)
+ has_additional_results=bool(new_search_cursor),
+ page_token=new_search_cursor)
@auth.method(
message_types.VoidMessage,
@@ -244,10 +243,9 @@ def enable_guest_mode(self, request):
device.enable_guest_mode(user_email)
except device_model.EnableGuestError as err:
raise endpoints.InternalServerErrorException(str(err))
- except (
- device_model.UnassignedDeviceError,
- device_model.GuestNotAllowedError,
- device_model.UnauthorizedError) as err:
+ except (device_model.UnassignedDeviceError,
+ device_model.GuestNotAllowedError,
+ device_model.UnauthorizedError) as err:
raise endpoints.UnauthorizedException(str(err))
else:
return message_types.VoidMessage()
@@ -265,14 +263,12 @@ def extend_loan(self, request):
user_email = user_lib.get_user_email()
try:
device.loan_extend(
- extend_date_time=request.extend_date,
- user_email=user_email)
+ extend_date_time=request.extend_date, user_email=user_email)
return message_types.VoidMessage()
except device_model.ExtendError as err:
raise endpoints.BadRequestException(str(err))
- except (
- device_model.UnassignedDeviceError,
- device_model.UnauthorizedError)as err:
+ except (device_model.UnassignedDeviceError,
+ device_model.UnauthorizedError) as err:
raise endpoints.UnauthorizedException(str(err))
@auth.method(
@@ -288,8 +284,7 @@ def mark_damaged(self, request):
user_email = user_lib.get_user_email()
try:
device.mark_damaged(
- user_email=user_email,
- damaged_reason=request.damaged_reason)
+ user_email=user_email, damaged_reason=request.damaged_reason)
except device_model.UnauthorizedError as err:
raise endpoints.UnauthorizedException(str(err))
return message_types.VoidMessage()
@@ -340,9 +335,8 @@ def mark_pending_return(self, request):
user_email = user_lib.get_user_email()
try:
device.mark_pending_return(user_email=user_email)
- except (
- device_model.UnassignedDeviceError,
- device_model.UnauthorizedError) as err:
+ except (device_model.UnassignedDeviceError,
+ device_model.UnauthorizedError) as err:
raise endpoints.UnauthorizedException(str(err))
return message_types.VoidMessage()
@@ -363,6 +357,50 @@ def resume_loan(self, request):
raise endpoints.UnauthorizedException(str(err))
return message_types.VoidMessage()
+ @auth.method(
+ device_messages.DeviceRequest,
+ message_types.VoidMessage,
+ name='complete_onboard',
+ path='user/complete_onboard',
+ http_method='POST')
+ def complete_onboard(self, request):
+ """complete onboard of a device."""
+ self.check_xsrf_token(self.request_state)
+ device = _get_device(request)
+ user_email = user_lib.get_user_email()
+ try:
+ device.complete_onboard(user_email=user_email)
+ except device_model.UnauthorizedError as err:
+ raise endpoints.UnauthorizedException(str(err))
+ return message_types.VoidMessage()
+
+ @auth.method(
+ device_messages.HistoryRequest,
+ device_messages.HistoryResponse,
+ name='history',
+ path='history',
+ http_method='POST',
+ permission=permissions.Permissions.READ_DEVICES)
+ def get_history(self, request):
+ """Gets historical data for a given device."""
+ self.check_xsrf_token(self.request_state)
+ client = bigquery.BigQueryClient()
+ device = _get_device(request.device)
+ serial = device.serial_number
+ info = client.get_device_info(serial)
+ if not info:
+ raise endpoints.NotFoundException(
+ 'No history for the requested serial number.')
+ historical_device = device_messages.Device()
+ response = device_messages.HistoryResponse()
+ historical_device.asset_tag = info[0][5]['asset_tag']
+ for row in info:
+ response.devices.append(historical_device)
+ response.timestamp.append(row[1])
+ response.actor.append(row[2])
+ response.summary.append(row[4])
+ return response
+
def _get_identifier_from_request(device_request):
"""Parses the DeviceMessage for an identifier to use to get a Device entity.
@@ -380,7 +418,8 @@ def _get_identifier_from_request(device_request):
return 'urlkey'
for device_identifier in [
- 'asset_tag', 'chrome_device_id', 'serial_number', 'identifier']:
+ 'asset_tag', 'chrome_device_id', 'serial_number', 'identifier'
+ ]:
if getattr(device_request, device_identifier, None):
return device_identifier
raise endpoints.BadRequestException(_NO_IDENTIFIERS_MSG)
diff --git a/loaner/web_app/backend/api/device_api_test.py b/loaner/web_app/backend/api/device_api_test.py
index 413a1a1f..0f47d239 100644
--- a/loaner/web_app/backend/api/device_api_test.py
+++ b/loaner/web_app/backend/api/device_api_test.py
@@ -34,8 +34,10 @@
from loaner.web_app.backend.api.messages import device_messages
from loaner.web_app.backend.api.messages import shared_messages
from loaner.web_app.backend.api.messages import shelf_messages
+from loaner.web_app.backend.clients import bigquery
from loaner.web_app.backend.clients import directory
from loaner.web_app.backend.lib import api_utils
+from loaner.web_app.backend.lib import search_utils
from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import device_model
from loaner.web_app.backend.models import shelf_model
@@ -50,6 +52,8 @@ def setUp(self):
self.service = device_api.DeviceApi()
self.login_admin_endpoints_user()
+ # Set bootstrap to completed so that maintenance mode will not be invoked.
+ config_model.Config.set('bootstrap_completed', True)
self.shelf = shelf_model.Shelf.enroll(
user_email=loanertest.USER_EMAIL,
location='NYC',
@@ -207,10 +211,9 @@ def test_unlock_move_ou_error(self, mock_directory_class):
@mock.patch('__main__.device_model.Device.device_audit_check')
def test_device_audit_check(self, mock_device_audit_check):
request = device_messages.DeviceRequest(identifier='6765')
- self.assertRaisesRegexp(
- device_api.endpoints.NotFoundException,
- device_api._NO_DEVICE_MSG % '6765',
- self.service.device_audit_check, request)
+ self.assertRaisesRegexp(device_api.endpoints.NotFoundException,
+ device_api._NO_DEVICE_MSG % '6765',
+ self.service.device_audit_check, request)
device_model.Device(
serial_number='12345',
@@ -238,6 +241,13 @@ def test_device_audit_check_device_damaged(self):
with self.assertRaises(device_api.endpoints.BadRequestException):
self.service.device_audit_check(request)
+ def test_device_audit_check_audit_error(self):
+ request = device_messages.DeviceRequest(
+ identifier=self.device.serial_number)
+ self.testbed.mock_raiseevent.side_effect = device_model.DeviceAuditEventError
+ with self.assertRaises(device_api.endpoints.BadRequestException):
+ self.service.device_audit_check(request)
+
@mock.patch.object(directory, 'DirectoryApiClient', autospec=True)
def test_get_device_not_found(self, mock_directory_class):
mock_directory_client = mock_directory_class.return_value
@@ -319,38 +329,42 @@ def test_get_device_directory_errors(self, test_error, mock_directory_class):
mock_directory_client.given_name.side_effect = test_error
self.assertIsNone(self.service.get_device(request).given_name)
- @parameterized.parameters(
- (device_messages.Device(enrolled=True), 2,),
- (device_messages.Device(current_ou='/'), 2,),
- (device_messages.Device(enrolled=False), 1,),
- (device_messages.Device(
- query=shared_messages.SearchRequest(query_string='sn:6789')), 1,),
- (device_messages.Device(
- query=shared_messages.SearchRequest(query_string='at:12345')), 1,))
+ @parameterized.parameters((
+ device_messages.Device(enrolled=True),
+ 2,
+ ), (
+ device_messages.Device(current_ou='/'),
+ 2,
+ ), (
+ device_messages.Device(enrolled=False),
+ 1,
+ ), (
+ device_messages.Device(
+ query=shared_messages.SearchRequest(query_string='sn:6789')),
+ 1,
+ ), (
+ device_messages.Device(
+ query=shared_messages.SearchRequest(query_string='at:12345')),
+ 1,
+ ))
def test_list_devices(self, request, response_length):
response = self.service.list_devices(request)
self.assertLen(response.devices, response_length)
- def test_list_devices_invalid_page_size(self):
- with self.assertRaises(endpoints.BadRequestException):
- request = device_messages.Device(page_size=0)
- self.service.list_devices(request)
-
def test_list_devices_with_search_constraints(self):
expressions = shared_messages.SearchExpression(expression='serial_number')
expected_response = device_messages.ListDevicesResponse(
- devices=[
- device_messages.Device(serial_number='6789', guest_permitted=True)
- ],
- total_results=1,
- total_pages=1)
+ devices=[device_messages.Device(serial_number='6789')],
+ has_additional_results=False)
request = device_messages.Device(
query=shared_messages.SearchRequest(
query_string='sn:6789',
expressions=[expressions],
returned_fields=['serial_number']))
response = self.service.list_devices(request)
- self.assertEqual(response, expected_response)
+ self.assertEqual(response.devices[0].serial_number,
+ expected_response.devices[0].serial_number)
+ self.assertFalse(response.has_additional_results)
def test_list_devices_with_filter_message(self):
message = device_messages.Device(
@@ -370,10 +384,10 @@ def test_list_devices_with_filter_message(self):
lost=False,
chrome_device_id='unique_id_2',
damaged=False,
- guest_permitted=True)
+ guest_permitted=True,
+ onboarded=False)
],
- total_results=1,
- total_pages=1)
+ has_additional_results=False)
self.assertEqual(response, expected_response)
@mock.patch('__main__.device_api.shelf_api.get_shelf')
@@ -388,17 +402,26 @@ def test_list_devices_with_shelf_filter(self, mock_get_shelf):
mock_get_shelf.assert_called_once_with(shelf_request_message)
self.assertLen(response.devices, 2)
- def test_list_devices_with_offset(self):
- request = device_messages.Device(page_size=1, page_number=1)
- response = self.service.list_devices(request)
- self.assertLen(response.devices, 1)
- previouse_response = response
-
- # Get next page results and make sure it's not the same as last.
- request = device_messages.Device(page_size=1, page_number=2)
- response = self.service.list_devices(request)
- self.assertLen(response.devices, 1)
- self.assertNotEqual(response, previouse_response)
+ def test_list_devices_with_page_token(self):
+ request = device_messages.Device(enrolled=True, page_size=1)
+ response_devices = []
+ while True:
+ response = self.service.list_devices(request)
+ for device in response.devices:
+ response_devices.append(device)
+ request = device_messages.Device(
+ enrolled=True, page_size=1, page_token=response.page_token)
+ if not response.has_additional_results:
+ break
+ self.assertLen(response_devices, 2)
+
+ @mock.patch.object(
+ search_utils, 'to_query', return_value='enrolled:enrolled', autospec=True)
+ def test_list_devices_with_malformed_page_token(self, mock_to_query):
+ """Test list devices with a fake token, raises BadRequestException."""
+ request = device_messages.Device(page_token='malformedtoken')
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.list_devices(request)
def test_list_devices_inactive_no_shelf(self):
request = device_messages.Device(enrolled=False, page_size=1)
@@ -415,10 +438,10 @@ def test_list_devices_inactive_no_shelf(self):
lost=self.unenrolled_device.lost,
chrome_device_id=self.unenrolled_device.chrome_device_id,
damaged=self.unenrolled_device.damaged,
- guest_permitted=True)
+ guest_permitted=True,
+ onboarded=False)
],
- total_results=1,
- total_pages=1)
+ has_additional_results=False)
self.assertEqual(expected_response, response)
@mock.patch('__main__.device_model.Device.list_by_user')
@@ -623,6 +646,16 @@ def test_mark_pending_return_unassigned(self):
self.service.mark_pending_return(
device_messages.DeviceRequest(urlkey=self.device.key.urlsafe()))
+ @mock.patch.object(device_model.Device, 'complete_onboard')
+ @mock.patch.object(root_api.Service, 'check_xsrf_token', autospec=True)
+ def test_complete_onboard(self, mock_xsrf_token, mock_completeonboard):
+ self.login_endpoints_user()
+ self.service.complete_onboard(
+ device_messages.DeviceRequest(urlkey=self.device.key.urlsafe()))
+ mock_completeonboard.assert_called_once_with(
+ user_email=loanertest.USER_EMAIL)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+
@mock.patch('__main__.device_model.Device.resume_loan')
@mock.patch.object(root_api.Service, 'check_xsrf_token', autospec=True)
def test_resume_loan(self, mock_xsrf_token, mock_resume_loan):
@@ -642,6 +675,97 @@ def test_resume_loan__unauthorized(self, mock_xsrf_token, mock_resume_loan):
self.service.resume_loan(
device_messages.DeviceRequest(urlkey=self.device.key.urlsafe()))
+ @mock.patch.object(bigquery, 'BigQueryClient')
+ @mock.patch.object(root_api.Service, 'check_xsrf_token', autospec=True)
+ def test_get_history(self, mock_xsrf_token, mock_bigquery):
+ device_request = device_messages.DeviceRequest()
+ device_request.asset_tag = '12345'
+ request = device_messages.HistoryRequest(device=device_request)
+
+ device_response = device_messages.Device()
+ device_response.asset_tag = '12345'
+
+ expected_response = device_messages.HistoryResponse()
+ for _ in range(2):
+ expected_response.devices.append(device_response)
+ expected_response.timestamp.append(
+ datetime.datetime(2019, 10, 22, 20, 43, 37))
+ expected_response.actor.append('testuser@google.com')
+ expected_response.summary.append(
+ 'Beginning new loan for user testuser@google.com with device 12345.')
+
+ bigquery_response = [
+ (u"Key('Device', 5158133238333440)",
+ datetime.datetime(2019, 10, 22, 20, 43,
+ 37), u'testuser@google.com', u'enable_guest_mode',
+ u'Beginning new loan for user testuser@google.com with device 12345.',
+ {
+ u'ou_changed_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'current_ou': u'/',
+ u'shelf': None,
+ u'due_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'chrome_device_id': u'unique_id_1',
+ u'mark_pending_return_date': None,
+ u'asset_tag': u'12345',
+ u'last_known_healthy': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'locked': False,
+ u'last_reminder': {
+ u'count': 1,
+ u'time': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'level': 1
+ },
+ u'next_reminder': None,
+ u'device_model': u'Chromebook',
+ u'enrolled': True,
+ u'serial_number': u'123ABC',
+ u'damaged': False,
+ u'onboarded': True,
+ u'assignment_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'damaged_reason': None,
+ u'assigned_user': u'testuser@google.com',
+ u'lost': False,
+ u'last_heartbeat': datetime.datetime(2019, 10, 22, 20, 43, 37)
+ }),
+ (u"Key('Device', 5158133238333440)",
+ datetime.datetime(2019, 10, 22, 20, 43,
+ 37), u'testuser@google.com', u'enable_guest_mode',
+ u'Beginning new loan for user testuser@google.com with device 12345.',
+ {
+ u'ou_changed_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'current_ou': u'/',
+ u'shelf': None,
+ u'due_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'chrome_device_id': u'unique_id_1',
+ u'mark_pending_return_date': None,
+ u'asset_tag': u'12345',
+ u'last_known_healthy': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'locked': False,
+ u'last_reminder': {
+ u'count': 1,
+ u'time': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'level': 1
+ },
+ u'next_reminder': None,
+ u'device_model': u'Chromebook',
+ u'enrolled': True,
+ u'serial_number': u'123ABC',
+ u'damaged': False,
+ u'onboarded': True,
+ u'assignment_date': datetime.datetime(2019, 10, 22, 20, 43, 37),
+ u'damaged_reason': None,
+ u'assigned_user': u'testuser@google.com',
+ u'lost': False,
+ u'last_heartbeat': datetime.datetime(2019, 10, 22, 20, 43, 37)
+ }),
+ ]
+ mock_bigquery_client = mock.Mock()
+ mock_bigquery_client.get_device_info.return_value = bigquery_response
+ mock_bigquery.return_value = mock_bigquery_client
+
+ actual_response = self.service.get_history(request)
+
+ self.assertEqual(actual_response, expected_response)
+
def test_get_device_errors(self):
# No identifiers.
with self.assertRaises(endpoints.BadRequestException):
diff --git a/loaner/web_app/backend/api/messages/BUILD b/loaner/web_app/backend/api/messages/BUILD
index ab7042fb..98cb9ead 100644
--- a/loaner/web_app/backend/api/messages/BUILD
+++ b/loaner/web_app/backend/api/messages/BUILD
@@ -1,21 +1,20 @@
# Description:
# BUILD file for //loaner/web_app/backend/api/messages.
+load(
+ "//loaner:builddefs.bzl",
+ "loaner_appengine_library", # @unused
+)
+
package(
default_visibility = [
"//loaner:__subpackages__",
],
)
-load(
- "//loaner:builddefs.bzl",
- "loaner_appengine_library",
-)
-
# ==============================================================================
# Libraries
# ==============================================================================
-
loaner_appengine_library(
name = "config_messages",
srcs = [
@@ -52,6 +51,7 @@ loaner_appengine_library(
deps = [
":shared_messages",
":shelf_messages",
+ ":tag_messages",
],
)
@@ -93,6 +93,13 @@ loaner_appengine_library(
],
)
+loaner_appengine_library(
+ name = "template_messages",
+ srcs = [
+ "template_messages.py",
+ ],
+)
+
loaner_appengine_library(
name = "user_messages",
srcs = [
diff --git a/loaner/web_app/backend/api/messages/bootstrap_messages.py b/loaner/web_app/backend/api/messages/bootstrap_messages.py
index 1bc2bf00..f86bb0ed 100644
--- a/loaner/web_app/backend/api/messages/bootstrap_messages.py
+++ b/loaner/web_app/backend/api/messages/bootstrap_messages.py
@@ -65,12 +65,16 @@ class BootstrapStatusResponse(messages.Message):
"""Bootstrap status response ProtoRPC message.
Attributes:
- enabled: bool, Indicates if the bootstrap is enabled.
started: bool, Indicated if the bootstrap has been started.
completed: bool, Indicated if the bootstrap is completed.
- tasks: BootstrapTask, A list of all of the tasks to be displayed.
+ tasks: List[BootstrapTask], A list of all of the tasks to be displayed.
+ app_version: str, The installed (deployed) version of the app.
+ running_version: str, The running (bootstrapped) version of the app.
+ is_update: bool, Whether this is an update for an existing installation.
"""
- enabled = messages.BooleanField(1)
started = messages.BooleanField(2)
completed = messages.BooleanField(3)
tasks = messages.MessageField(BootstrapTask, 4, repeated=True)
+ app_version = messages.StringField(5)
+ running_version = messages.StringField(6)
+ is_update = messages.BooleanField(7)
diff --git a/loaner/web_app/backend/api/messages/bootstrap_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/bootstrap_messages_py23_migration_test.py
new file mode 100644
index 00000000..a948d4fa
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/bootstrap_messages_py23_migration_test.py
@@ -0,0 +1,70 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.bootstrap_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import bootstrap_messages
+from absl.testing import absltest
+
+
+class BootstrapMessagesPy23MigrationTest(absltest.TestCase):
+
+ def setUp(self):
+ super(BootstrapMessagesPy23MigrationTest, self).setUp()
+ self.bootstrap_task_kwarg = bootstrap_messages.BootstrapTaskKwarg(
+ name='abc', value='def')
+ self.bootstrap_task = bootstrap_messages.BootstrapTask(
+ name='name_abc', description='description_abc', success=True,
+ details='details_abc', kwargs=[self.bootstrap_task_kwarg])
+
+ def testBootstrapTaskKwarg(self):
+ bootstrap_task_kwarg = self.bootstrap_task_kwarg
+ self.assertEqual('abc', bootstrap_task_kwarg.name)
+ self.assertEqual('def', bootstrap_task_kwarg.value)
+
+ def testBootstrapTask(self):
+ bootstrap_task = self.bootstrap_task
+ self.assertEqual('name_abc', bootstrap_task.name)
+ self.assertEqual('description_abc', bootstrap_task.description)
+ self.assertTrue(bootstrap_task.success)
+ self.assertEqual(None, bootstrap_task.timestamp)
+ self.assertEqual('details_abc', bootstrap_task.details)
+ self.assertEqual('abc', bootstrap_task.kwargs[0].name)
+ self.assertEqual('def', bootstrap_task.kwargs[0].value)
+
+ def testRunBootstrapRequest(self):
+ request = bootstrap_messages.RunBootstrapRequest(requested_tasks=[
+ self.bootstrap_task])
+ self.assertEqual('name_abc', request.requested_tasks[0].name)
+
+ def testRunBootstrapResponse(self):
+ response = bootstrap_messages.BootstrapStatusResponse(
+ tasks=[self.bootstrap_task], started=True, completed=False,
+ app_version='25', running_version='11', is_update=True)
+ self.assertEqual('name_abc', response.tasks[0].name)
+ self.assertEqual('abc', response.tasks[0].kwargs[0].name)
+ self.assertTrue(response.started)
+ self.assertFalse(response.completed)
+ self.assertEqual('25', response.app_version)
+ self.assertEqual('11', response.running_version)
+ self.assertTrue(response.is_update)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/chrome_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/chrome_messages_py23_migration_test.py
new file mode 100644
index 00000000..4f620de6
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/chrome_messages_py23_migration_test.py
@@ -0,0 +1,41 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.chrome_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import chrome_messages
+from absl.testing import absltest
+
+
+class ChromeMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testHeartbeatRequest(self):
+ chrome = chrome_messages.HeartbeatRequest(device_id='1')
+ self.assertEqual(chrome.device_id, '1')
+
+ def testHeartbeatResponse(self):
+ chrome = chrome_messages.HeartbeatResponse(
+ is_enrolled=True, start_assignment=True, silent_onboarding=True)
+ self.assertEqual(chrome.is_enrolled, True)
+ self.assertEqual(chrome.start_assignment, True)
+ self.assertEqual(chrome.silent_onboarding, True)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/config_messages.py b/loaner/web_app/backend/api/messages/config_messages.py
index e04c5eab..2894444f 100644
--- a/loaner/web_app/backend/api/messages/config_messages.py
+++ b/loaner/web_app/backend/api/messages/config_messages.py
@@ -46,7 +46,7 @@ class ConfigResponse(messages.Message):
name: str, The name of the name being returned..
string_value: str, The string value of the name.
integer_value: int, The integer value of the name.
- boolean_value: bool, The boolean value of the seting.
+ boolean_value: bool, The boolean value of the setting.
list_value: list, The list value of the name.
"""
name = messages.StringField(1)
@@ -74,7 +74,7 @@ class UpdateConfig(messages.Message):
config_type: ConfigType, The type of config for which to request.
string_value: str, The string value of the name being updated.
integer_value: int, The integer value of the name being updated.
- boolean_value: bool, The boolean value of the seting being updated.
+ boolean_value: bool, The boolean value of the setting being updated.
list_value: list, The list value of the name being updated.
"""
name = messages.StringField(1, required=True)
diff --git a/loaner/web_app/backend/api/messages/config_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/config_messages_py23_migration_test.py
new file mode 100644
index 00000000..8b55be0b
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/config_messages_py23_migration_test.py
@@ -0,0 +1,71 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.config_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import config_messages
+from absl.testing import absltest
+
+
+class ConfigMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testGetConfigRequest(self):
+ config = config_messages.GetConfigRequest(
+ name='test', config_type=config_messages.ConfigType(1))
+ self.assertEqual(config.name, 'test')
+ self.assertEqual(config.config_type.name, 'STRING')
+
+ def testConfigResponse(self):
+ config = config_messages.ConfigResponse(
+ name='test',
+ string_value='test',
+ integer_value=1,
+ boolean_value=False,
+ list_value=['test'])
+ self.assertEqual(config.name, 'test')
+ self.assertEqual(config.string_value, 'test')
+ self.assertEqual(config.integer_value, 1)
+ self.assertEqual(config.boolean_value, False)
+ self.assertEqual(config.list_value, ['test'])
+
+ def testListConfigsResponse(self):
+ config = config_messages.ListConfigsResponse(
+ configs=[config_messages.ConfigResponse(name='test')])
+ self.assertEqual(config.configs[0].name, 'test')
+
+ def testUpdateConfigRequest(self):
+ config = config_messages.UpdateConfigRequest(
+ config=[config_messages.UpdateConfig(name='test')])
+ self.assertEqual(config.config[0].name, 'test')
+
+ def testUpdateConfig(self):
+ config = config_messages.UpdateConfig(
+ name='test',
+ config_type=config_messages.ConfigType(1),
+ integer_value=1,
+ boolean_value=False,
+ list_value=['test'])
+ self.assertEqual(config.name, 'test')
+ self.assertEqual(config.config_type.name, 'STRING')
+ self.assertEqual(config.integer_value, 1)
+ self.assertEqual(config.boolean_value, False)
+ self.assertEqual(config.list_value, ['test'])
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/datastore_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/datastore_messages_py23_migration_test.py
new file mode 100644
index 00000000..61b1efbe
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/datastore_messages_py23_migration_test.py
@@ -0,0 +1,35 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.datastore_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import datastore_messages
+from absl.testing import absltest
+
+
+class DataStoreMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testImportYamlRequest(self):
+ import_yaml_req = datastore_messages.ImportYamlRequest(
+ yaml='FAKE-YAML.yaml')
+ self.assertEqual(import_yaml_req.yaml, 'FAKE-YAML.yaml')
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/device_messages.py b/loaner/web_app/backend/api/messages/device_messages.py
index 0815cbd3..2fbe48c7 100644
--- a/loaner/web_app/backend/api/messages/device_messages.py
+++ b/loaner/web_app/backend/api/messages/device_messages.py
@@ -23,6 +23,7 @@
from loaner.web_app.backend.api.messages import shared_messages
from loaner.web_app.backend.api.messages import shelf_messages
+from loaner.web_app.backend.api.messages import tag_messages
class Reminder(messages.Message):
@@ -30,7 +31,7 @@ class Reminder(messages.Message):
Attributes:
level: int, Indicates if a reminder is due, overdue, or massively overdue.
- time: datetime, The date at which the Device's borrower was reminded.
+ time: datetime, The date at which the Device's assignee was reminded.
count: int, Indicates the number of reminders seen.
"""
level = messages.IntegerField(1)
@@ -84,8 +85,8 @@ class Device(messages.Message):
last_reminder: Reminder, Level, time, and count of the last reminder
the device had.
next_reminder: Reminder, Level, time, and count of the next reminder.
+ page_token: str, A page token to query next page results.
page_size: int, The number of results to query for and display.
- page_number: int, the page index to offset the results.
max_extend_date: datetime, Indicates maximum extend date a device can have.
guest_enabled: bool, Indicates if guest mode has been already enabled.
guest_permitted: bool, Indicates if guest mode has been allowed.
@@ -93,6 +94,9 @@ class Device(messages.Message):
query: shared_message.SearchRequest, a message containing query options to
conduct a search on an index.
overdue: bool, Indicates that the due date has passed.
+ tags: List[tag_model.TagData], a list of TagData objects associated with the
+ device.
+ onboarded: bool, Indicates that the device has been fully onboarded.
"""
serial_number = messages.StringField(1)
asset_tag = messages.StringField(2)
@@ -116,32 +120,34 @@ class Device(messages.Message):
damaged_reason = messages.StringField(20)
last_reminder = messages.MessageField(Reminder, 21)
next_reminder = messages.MessageField(Reminder, 22)
- page_size = messages.IntegerField(23, default=10)
- page_number = messages.IntegerField(24, default=1)
+ page_token = messages.StringField(23)
+ page_size = messages.IntegerField(24, default=25)
max_extend_date = message_types.DateTimeField(25)
guest_enabled = messages.BooleanField(26)
guest_permitted = messages.BooleanField(27)
given_name = messages.StringField(28)
query = messages.MessageField(shared_messages.SearchRequest, 29)
overdue = messages.BooleanField(30)
+ tags = messages.MessageField(tag_messages.TagData, 31, repeated=True)
+ onboarded = messages.BooleanField(32)
class ListDevicesResponse(messages.Message):
- """List device response ProtoRPC message.
+ """ListDevicesResponse ProtoRPC message.
Attributes:
devices: List[Device], The list of devices being returned.
- total_results: int, The total number of results for a query.
- total_pages: int, The total number of pages needed to display all of the
- results.
+ has_additional_results: bool, If there are more results to be displayed.
+ page_token: str, A page token that will allow be used to query for
+ additional results.
"""
devices = messages.MessageField(Device, 1, repeated=True)
- total_results = messages.IntegerField(2)
- total_pages = messages.IntegerField(3)
+ has_additional_results = messages.BooleanField(2)
+ page_token = messages.StringField(3)
class DamagedRequest(messages.Message):
- """Damaged device ProtoRPC message.
+ """DamagedRequest ProtoRPC message.
Attributes:
device: DeviceRequest, A device to be fetched.
@@ -152,9 +158,9 @@ class DamagedRequest(messages.Message):
class ExtendLoanRequest(messages.Message):
- """Loan extension request ProtoRPC message.
+ """ExtendLoanRequest ProtoRPC message.
- Atrributes:
+ Attributes:
device: DeviceRequest, A device to be fetched.
extend_date: datetime, The date to extend the loan for.
"""
@@ -163,9 +169,33 @@ class ExtendLoanRequest(messages.Message):
class ListUserDeviceResponse(messages.Message):
- """UserDeviceResponse ProtoRPC message.
+ """ListUserDeviceResponse ProtoRPC message.
Attributes:
devices: List[Device], The list of devices assigned to the user.
"""
devices = messages.MessageField(Device, 1, repeated=True)
+
+
+class HistoryRequest(messages.Message):
+ """HistoryRequest: ProtoRPC message.
+
+ Attributes:
+ device: DeviceRequest, The device to be used for lookup.
+ """
+ device = messages.MessageField(DeviceRequest, 1)
+
+
+class HistoryResponse(messages.Message):
+ """HistoryResponse: ProtoRPC message.
+
+ Attributes:
+ devices: List[Device], The list of historical changes made to the device.
+ timestamp: datetime, The date and time when the change was made.
+ actor: str, The person or entity who made the change.
+ summary: str, The details of the change that occurred.
+ """
+ devices = messages.MessageField(Device, 1, repeated=True)
+ timestamp = message_types.DateTimeField(2, repeated=True)
+ actor = messages.StringField(3, repeated=True)
+ summary = messages.StringField(4, repeated=True)
diff --git a/loaner/web_app/backend/api/messages/device_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/device_messages_py23_migration_test.py
new file mode 100644
index 00000000..a4e6da3e
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/device_messages_py23_migration_test.py
@@ -0,0 +1,188 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.device_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import datetime
+
+from loaner.web_app.backend.api.messages import device_messages
+from absl.testing import absltest
+
+
+class DeviceMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testReminder(self):
+ now = datetime.datetime.now()
+ reminder = device_messages.Reminder(level=2, time=now, count=4)
+
+ self.assertEqual(reminder.level, 2)
+ self.assertEqual(reminder.time, now)
+ self.assertEqual(reminder.count, 4)
+
+ def testDeviceRequest(self):
+ device_request = device_messages.DeviceRequest(
+ asset_tag='FAKE-TAG',
+ chrome_device_id='FAKE-CHROME-DEVICE-ID',
+ serial_number='FAKE-SERIAL-NUMBER',
+ urlkey='FAKE-URL-KEY',
+ identifier='FAKE-IDENTIFIER')
+
+ self.assertEqual(device_request.asset_tag, 'FAKE-TAG')
+ self.assertEqual(device_request.chrome_device_id, 'FAKE-CHROME-DEVICE-ID')
+ self.assertEqual(device_request.serial_number, 'FAKE-SERIAL-NUMBER')
+ self.assertEqual(device_request.urlkey, 'FAKE-URL-KEY')
+ self.assertEqual(device_request.identifier, 'FAKE-IDENTIFIER')
+
+ def testDevice(self):
+ due_date = datetime.datetime.now()
+ last_heartbeat = datetime.datetime.now()
+ assignment_date = datetime.datetime.now()
+ ou_changed_date = datetime.datetime.now()
+ last_known_healthy = datetime.datetime.now()
+ mark_pending_return_date = datetime.datetime.now()
+ max_extend_date = datetime.datetime.now()
+
+ device = device_messages.Device(
+ serial_number='FAKE-SERIAL-NUMBER',
+ asset_tag='FAKE-TAG',
+ identifier='FAKE-IDENTIFIER',
+ urlkey='FAKE-URL-KEY',
+ enrolled=False,
+ device_model='FAKE-DEVICE-MODEL',
+ due_date=due_date,
+ last_known_healthy=last_known_healthy,
+ assigned_user='FAKE-ASSIGNED-USER',
+ assignment_date=assignment_date,
+ current_ou='FAKE-CURRENT-OU',
+ ou_changed_date=ou_changed_date,
+ locked=True,
+ lost=True,
+ mark_pending_return_date=mark_pending_return_date,
+ chrome_device_id='FAKE-CHROME-DEVICE-ID',
+ last_heartbeat=last_heartbeat,
+ damaged=True,
+ damaged_reason='FAKE-DAMAGED-REASON',
+ page_token='FAKE-PAGE-TOKEN',
+ page_size=50,
+ max_extend_date=max_extend_date,
+ guest_enabled=False,
+ guest_permitted=True,
+ given_name='FAKE-GIVEN-NAME',
+ overdue=True,
+ onboarded=True)
+
+ self.assertTrue(device.lost)
+ self.assertTrue(device.locked)
+ self.assertTrue(device.overdue)
+ self.assertTrue(device.damaged)
+ self.assertFalse(device.enrolled)
+ self.assertTrue(device.onboarded)
+ self.assertEqual(device.page_size, 50)
+ self.assertFalse(device.guest_enabled)
+ self.assertTrue(device.guest_permitted)
+ self.assertEqual(device.due_date, due_date)
+
+ self.assertEqual(device.asset_tag, 'FAKE-TAG')
+ self.assertEqual(device.urlkey, 'FAKE-URL-KEY')
+ self.assertEqual(device.identifier, 'FAKE-IDENTIFIER')
+ self.assertEqual(device.current_ou, 'FAKE-CURRENT-OU')
+ self.assertEqual(device.page_token, 'FAKE-PAGE-TOKEN')
+ self.assertEqual(device.given_name, 'FAKE-GIVEN-NAME')
+ self.assertEqual(device.last_heartbeat, last_heartbeat)
+ self.assertEqual(device.assignment_date, assignment_date)
+ self.assertEqual(device.ou_changed_date, ou_changed_date)
+ self.assertEqual(device.max_extend_date, max_extend_date)
+ self.assertEqual(device.device_model, 'FAKE-DEVICE-MODEL')
+ self.assertEqual(device.serial_number, 'FAKE-SERIAL-NUMBER')
+ self.assertEqual(device.assigned_user, 'FAKE-ASSIGNED-USER')
+ self.assertEqual(device.damaged_reason, 'FAKE-DAMAGED-REASON')
+ self.assertEqual(device.last_known_healthy, last_known_healthy)
+ self.assertEqual(device.chrome_device_id, 'FAKE-CHROME-DEVICE-ID')
+ self.assertEqual(device.mark_pending_return_date, mark_pending_return_date)
+
+ def testListDevicesResponse(self):
+ device1 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-1')
+ device2 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-2')
+ list_device_resp = device_messages.ListDevicesResponse(
+ devices=[device1, device2],
+ has_additional_results=True,
+ page_token='FAKE-PAGE-TOKEN')
+
+ self.assertTrue(list_device_resp.has_additional_results)
+ self.assertEqual(list_device_resp.devices[0].serial_number,
+ 'FAKE-DEVICE-SERIAL-1')
+ self.assertEqual(list_device_resp.devices[1].serial_number,
+ 'FAKE-DEVICE-SERIAL-2')
+ self.assertEqual(list_device_resp.page_token, 'FAKE-PAGE-TOKEN')
+
+ def testDamagedRequest(self):
+ device = device_messages.DeviceRequest(asset_tag='FAKE-TAG')
+ damaged_request = device_messages.DamagedRequest(
+ device=device, damaged_reason='FAKE-DAMAGED-REASON')
+
+ self.assertEqual(damaged_request.device.asset_tag, 'FAKE-TAG')
+ self.assertEqual(damaged_request.damaged_reason, 'FAKE-DAMAGED-REASON')
+
+ def testExtendLoanRequest(self):
+ now = datetime.datetime.now()
+ device = device_messages.DeviceRequest(asset_tag='FAKE-TAG')
+ extend_loan_req = device_messages.ExtendLoanRequest(
+ device=device, extend_date=now)
+
+ self.assertEqual(extend_loan_req.extend_date, now)
+ self.assertEqual(extend_loan_req.device.asset_tag, 'FAKE-TAG')
+
+ def testListUserDeviceResponse(self):
+ device1 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-1')
+ device2 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-2')
+
+ list_device_resp = device_messages.ListUserDeviceResponse(
+ devices=[device1, device2])
+
+ self.assertEqual(list_device_resp.devices[0].serial_number,
+ 'FAKE-DEVICE-SERIAL-1')
+ self.assertEqual(list_device_resp.devices[1].serial_number,
+ 'FAKE-DEVICE-SERIAL-2')
+
+ def testHistoryRequest(self):
+ hist_req = device_messages.HistoryRequest(
+ device=device_messages.DeviceRequest(asset_tag='FAKE-DEVICE-TAG'))
+
+ self.assertEqual(hist_req.device.asset_tag, 'FAKE-DEVICE-TAG')
+
+ def testHistoryResponse(self):
+ now = datetime.datetime.now()
+ device1 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-1')
+ device2 = device_messages.Device(serial_number='FAKE-DEVICE-SERIAL-2')
+
+ hist_resp = device_messages.HistoryResponse(
+ devices=[device1, device2],
+ timestamp=[now],
+ actor=['FAKE-ACTOR-1'],
+ summary=['FAKE-SUMMARY-1', 'FAKE-SUMMARY-2'])
+
+ self.assertListEqual(hist_resp.timestamp, [now])
+ self.assertListEqual(hist_resp.actor, ['FAKE-ACTOR-1'])
+ self.assertListEqual(hist_resp.summary,
+ ['FAKE-SUMMARY-1', 'FAKE-SUMMARY-2'])
+ self.assertEqual(hist_resp.devices[0].serial_number, 'FAKE-DEVICE-SERIAL-1')
+ self.assertEqual(hist_resp.devices[1].serial_number, 'FAKE-DEVICE-SERIAL-2')
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/search_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/search_messages_py23_migration_test.py
new file mode 100644
index 00000000..92bbc453
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/search_messages_py23_migration_test.py
@@ -0,0 +1,42 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.search_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import search_messages
+from absl.testing import absltest
+
+
+class SearchMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testSearchIndexEnumDevice(self):
+ search_index_enum = search_messages.SearchIndexEnum(0)
+ self.assertEqual(search_index_enum.name, 'DEVICE')
+
+ def testSearchIndexEnumShelf(self):
+ search_index_enum = search_messages.SearchIndexEnum(1)
+ self.assertEqual(search_index_enum.name, 'SHELF')
+
+ def testSearchMessage(self):
+ search_messages_output = search_messages.SearchMessage()
+ self.assertTrue(hasattr(search_messages_output, 'model'))
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/shared_messages.py b/loaner/web_app/backend/api/messages/shared_messages.py
index 8342683f..991c7b42 100644
--- a/loaner/web_app/backend/api/messages/shared_messages.py
+++ b/loaner/web_app/backend/api/messages/shared_messages.py
@@ -52,7 +52,7 @@ class SearchRequest(messages.Message):
query_string: str, A query string to conduct a search on an index.
expressions: List[SearchExpression], A list representing a multi-dimensional
sort of Documents.
- returned_fileds: List[str], A list of basestring as facet name to return
+ returned_fields: List[str], A list of basestring as facet name to return
specific facet with the result.
"""
query_string = messages.StringField(1)
diff --git a/loaner/web_app/backend/api/messages/shared_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/shared_messages_py23_migration_test.py
new file mode 100644
index 00000000..750d21b0
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/shared_messages_py23_migration_test.py
@@ -0,0 +1,62 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.shared_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import shared_messages
+from absl.testing import absltest
+
+
+class SharedMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testSortDirectionAscending(self):
+ sort_direction_asc = shared_messages.SortDirection(0)
+ self.assertEqual(sort_direction_asc.name, 'ASCENDING')
+
+ def testSortDirectionDescending(self):
+ sort_direction_desc = shared_messages.SortDirection(1)
+ self.assertEqual(sort_direction_desc.name, 'DESCENDING')
+
+ def testSearchExpression(self):
+ search_exp = shared_messages.SearchExpression(
+ expression='FAKE-EXPRESSION',
+ direction=shared_messages.SortDirection(0))
+ self.assertEqual(search_exp.expression, 'FAKE-EXPRESSION')
+ self.assertEqual(search_exp.direction.name, 'ASCENDING')
+
+ def testSearchRequest(self):
+ search_exp = shared_messages.SearchExpression(
+ expression='FAKE-EXPRESSION',
+ direction=shared_messages.SortDirection(0))
+
+ search_request = shared_messages.SearchRequest(
+ query_string='FAKE-QUERY-STRING',
+ expressions=[search_exp],
+ returned_fields=['FAKE-RETURN'])
+
+ self.assertEqual(search_request.query_string, 'FAKE-QUERY-STRING')
+ self.assertListEqual(search_request.returned_fields, ['FAKE-RETURN'])
+ self.assertEqual(
+ search_request.expressions[0].expression, 'FAKE-EXPRESSION')
+ self.assertEqual(
+ search_request.expressions[0].direction.name, 'ASCENDING')
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/shelf_messages.py b/loaner/web_app/backend/api/messages/shelf_messages.py
index e3e90366..000b2247 100644
--- a/loaner/web_app/backend/api/messages/shelf_messages.py
+++ b/loaner/web_app/backend/api/messages/shelf_messages.py
@@ -55,8 +55,8 @@ class Shelf(messages.Message):
responsible_for_audit: str, The party responsible for audits.
last_audit_time: datetime, Indicates the last audit time.
last_audit_by: str, Indicates the last user to audit the shelf.
+ page_token: str, a page token to query next page results.
page_size: int, The number of results to query for and display.
- page_number: int, The page index to offset the results.
shelf_request: ShelfRequest, A message containing the unique identifier to
be used to retrieve the shelf.
query: shared_message.SearchRequest, a message containing query options to
@@ -76,11 +76,12 @@ class Shelf(messages.Message):
responsible_for_audit = messages.StringField(11)
last_audit_time = message_types.DateTimeField(12)
last_audit_by = messages.StringField(13)
- page_size = messages.IntegerField(14, default=10)
- page_number = messages.IntegerField(15, default=1)
+ page_token = messages.StringField(14)
+ page_size = messages.IntegerField(15, default=25)
shelf_request = messages.MessageField(ShelfRequest, 16)
query = messages.MessageField(shared_messages.SearchRequest, 17)
audit_interval_override = messages.IntegerField(18)
+ audit_enabled = messages.BooleanField(19)
class EnrollShelfRequest(messages.Message):
@@ -143,13 +144,13 @@ class ListShelfResponse(messages.Message):
Attributes:
shelves: List[Shelf], The list of shelves being returned.
- total_results: int, The total number of results for a query.
- total_pages: int, The total number of pages needed to display all of the
- results.
+ has_additional_results: bool, If there are more results to be displayed.
+ page_token: str, A page token that will allow be used to query for
+ additional results.
"""
shelves = messages.MessageField(Shelf, 1, repeated=True)
- total_results = messages.IntegerField(2)
- total_pages = messages.IntegerField(3)
+ has_additional_results = messages.BooleanField(2)
+ page_token = messages.StringField(3)
class ShelfAuditRequest(messages.Message):
diff --git a/loaner/web_app/backend/api/messages/shelf_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/shelf_messages_py23_migration_test.py
new file mode 100644
index 00000000..6a5f8f9d
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/shelf_messages_py23_migration_test.py
@@ -0,0 +1,148 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.shelf_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import datetime
+
+from loaner.web_app.backend.api.messages import shelf_messages
+from absl.testing import absltest
+
+
+class ShelfMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testShelfRequest(self):
+ shelf_req = shelf_messages.ShelfRequest(
+ location='FAKE-LOCATION', urlsafe_key='FAKE-URL-SAFE-KEY')
+ self.assertEqual(shelf_req.location, 'FAKE-LOCATION')
+ self.assertEqual(shelf_req.urlsafe_key, 'FAKE-URL-SAFE-KEY')
+
+ def testShelf(self):
+ last_audit_date = datetime.datetime.now()
+ shelf = shelf_messages.Shelf(
+ enabled=True,
+ friendly_name='FAKE-FRIENDLY-NAME',
+ location='FAKE-LOCATION',
+ identifier='FAKE-IDENTIFIER',
+ latitude=20.45,
+ longitude=30.85,
+ altitude=25.3,
+ capacity=10,
+ audit_notification_enabled=True,
+ audit_requested=False,
+ responsible_for_audit='FAKE-AUDIT-PERSON',
+ last_audit_time=last_audit_date,
+ last_audit_by='FAKE-LAST-AUDIT-PERSON',
+ page_token='FAKE-PAGE-TOKEN',
+ page_size=50,
+ audit_interval_override=20,
+ audit_enabled=True)
+
+ self.assertTrue(shelf.enabled)
+ self.assertTrue(shelf.audit_enabled)
+ self.assertFalse(shelf.audit_requested)
+ self.assertTrue(shelf.audit_notification_enabled)
+
+ self.assertEqual(shelf.capacity, 10)
+ self.assertEqual(shelf.page_size, 50)
+ self.assertEqual(shelf.altitude, 25.3)
+ self.assertEqual(shelf.latitude, 20.45)
+ self.assertEqual(shelf.longitude, 30.85)
+ self.assertEqual(shelf.audit_interval_override, 20)
+
+ self.assertEqual(shelf.last_audit_time, last_audit_date)
+
+ self.assertEqual(shelf.location, 'FAKE-LOCATION')
+ self.assertEqual(shelf.identifier, 'FAKE-IDENTIFIER')
+ self.assertEqual(shelf.page_token, 'FAKE-PAGE-TOKEN')
+ self.assertEqual(shelf.friendly_name, 'FAKE-FRIENDLY-NAME')
+ self.assertEqual(shelf.last_audit_by, 'FAKE-LAST-AUDIT-PERSON')
+ self.assertEqual(shelf.responsible_for_audit, 'FAKE-AUDIT-PERSON')
+
+ def testEnrollShelfRequest(self):
+ enroll_shelf_req = shelf_messages.EnrollShelfRequest(
+ friendly_name='FAKE-FRIENDLY-NAME',
+ location='FAKE-LOCATION',
+ latitude=10.2,
+ longitude=5.3,
+ altitude=15.7,
+ capacity=28,
+ audit_notification_enabled=False,
+ responsible_for_audit='FAKE-RESPONSIBLE',
+ audit_interval_override=34)
+
+ self.assertEqual(enroll_shelf_req.capacity, 28)
+ self.assertEqual(enroll_shelf_req.latitude, 10.2)
+ self.assertEqual(enroll_shelf_req.longitude, 5.3)
+ self.assertEqual(enroll_shelf_req.altitude, 15.7)
+ self.assertEqual(enroll_shelf_req.audit_interval_override, 34)
+
+ self.assertFalse(enroll_shelf_req.audit_notification_enabled)
+
+ self.assertEqual(enroll_shelf_req.location, 'FAKE-LOCATION')
+ self.assertEqual(enroll_shelf_req.friendly_name, 'FAKE-FRIENDLY-NAME')
+ self.assertEqual(enroll_shelf_req.responsible_for_audit, 'FAKE-RESPONSIBLE')
+
+ def testUpdateShelfRequest(self):
+ update_shelf_req = shelf_messages.UpdateShelfRequest(
+ friendly_name='FAKE-FRIENDLY-NAME',
+ location='FAKE-LOCATION',
+ capacity=50,
+ latitude=20.2,
+ longitude=10.3,
+ altitude=44.1,
+ audit_interval_override=9,
+ responsible_for_audit='FAKE-RESPONSIBLE',
+ audit_notification_enabled=True)
+
+ self.assertEqual(update_shelf_req.capacity, 50)
+ self.assertEqual(update_shelf_req.altitude, 44.1)
+ self.assertEqual(update_shelf_req.latitude, 20.2)
+ self.assertEqual(update_shelf_req.longitude, 10.3)
+ self.assertEqual(update_shelf_req.audit_interval_override, 9)
+
+ self.assertTrue(update_shelf_req.audit_notification_enabled)
+
+ self.assertEqual(update_shelf_req.location, 'FAKE-LOCATION')
+ self.assertEqual(update_shelf_req.friendly_name, 'FAKE-FRIENDLY-NAME')
+ self.assertEqual(update_shelf_req.responsible_for_audit, 'FAKE-RESPONSIBLE')
+
+ def testListShelfResponse(self):
+ list_shelf_resp = shelf_messages.ListShelfResponse(
+ shelves=[],
+ has_additional_results=True,
+ page_token='FAKE-PAGE-TOKEN')
+
+ self.assertListEqual(list_shelf_resp.shelves, [])
+ self.assertTrue(list_shelf_resp.has_additional_results)
+ self.assertEqual(list_shelf_resp.page_token, 'FAKE-PAGE-TOKEN')
+
+ def testShelfAuditRequest(self):
+ shelf_audit_req = shelf_messages.ShelfAuditRequest(
+ shelf_request=None,
+ device_identifiers=['FAKE-IDENTIFIER-1', 'FAKE-IDENTIFIER-2'])
+
+ self.assertIsNone(shelf_audit_req.shelf_request)
+ self.assertListEqual(
+ shelf_audit_req.device_identifiers,
+ ['FAKE-IDENTIFIER-1', 'FAKE-IDENTIFIER-2'])
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/survey_messages.py b/loaner/web_app/backend/api/messages/survey_messages.py
index 3f8ed868..cc61a4ca 100644
--- a/loaner/web_app/backend/api/messages/survey_messages.py
+++ b/loaner/web_app/backend/api/messages/survey_messages.py
@@ -113,7 +113,7 @@ class QuestionSubmission(messages.Message):
Attributes:
question_urlsafe_key: str, The urlsafe ndb.Key for a
- survey_models.Survey instace.
+ survey_models.Survey instance.
selected_answer: Answer, The answer a user selected.
more_info_text: str, the extra info optionally provided for the given
Answer.
diff --git a/loaner/web_app/backend/api/messages/tag_messages.py b/loaner/web_app/backend/api/messages/tag_messages.py
index 7d58f38b..cbd1f6e3 100644
--- a/loaner/web_app/backend/api/messages/tag_messages.py
+++ b/loaner/web_app/backend/api/messages/tag_messages.py
@@ -31,12 +31,15 @@ class Tag(messages.Message):
protect: bool, Whether the tag is protected from user manipulation; this
field will only be included in response messages.
description: str, The description for the tag.
+ urlsafe_key: str, The urlsafe representation of the ndb.Key of the tag; this
+ field will only be included in response messages.
"""
name = messages.StringField(1)
hidden = messages.BooleanField(2, default=False)
color = messages.StringField(3)
protect = messages.BooleanField(4)
description = messages.StringField(5)
+ urlsafe_key = messages.StringField(6)
class CreateTagRequest(messages.Message):
@@ -48,6 +51,15 @@ class CreateTagRequest(messages.Message):
tag = messages.MessageField(Tag, 1)
+class UpdateTagRequest(messages.Message):
+ """UpdateTagRequest ProtoRPC message.
+
+ Attributes:
+ tag: Tag, A tag to update.
+ """
+ tag = messages.MessageField(Tag, 1)
+
+
class TagRequest(messages.Message):
"""TagRequest ProtoRPC message.
@@ -56,3 +68,47 @@ class TagRequest(messages.Message):
requested tag.
"""
urlsafe_key = messages.StringField(1)
+
+
+class ListTagRequest(messages.Message):
+ """ListTagRequest ProtoRPC message.
+
+ Attributes:
+ page_size: int, The number of results to return.
+ cursor: str, The base64-encoded cursor string specifying where to start the
+ query.
+ page_index: int, A human-readable page index to navigate to that will be
+ used in the calculation of the offset.
+ include_hidden_tags: bool, Whether to include hidden tags in the results.
+ """
+ page_size = messages.IntegerField(1, default=10)
+ cursor = messages.StringField(2)
+ page_index = messages.IntegerField(3, default=1)
+ include_hidden_tags = messages.BooleanField(4, default=False)
+
+
+class ListTagResponse(messages.Message):
+ """ListTagResponse ProtoRPC message.
+
+ Attributes:
+ tags: List[Tag], The list of tags being returned.
+ cursor: str, The base64-encoded cursor string denoting the position of the
+ last result retrieved.
+ has_additional_results: bool, Whether there are additional results to be
+ retrieved.
+ """
+ tags = messages.MessageField(Tag, 1, repeated=True)
+ cursor = messages.StringField(2)
+ has_additional_results = messages.BooleanField(3)
+ total_pages = messages.IntegerField(4)
+
+
+class TagData(messages.Message):
+ """TagData ProtoRPC message.
+
+ Attributes:
+ tag: Tag, an instance of a Tag entity.
+ more_info: str, an informational field about this particular tag reference.
+ """
+ tag = messages.MessageField(Tag, 1)
+ more_info = messages.StringField(2)
diff --git a/loaner/web_app/backend/api/messages/tag_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/tag_messages_py23_migration_test.py
new file mode 100644
index 00000000..dd956b3f
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/tag_messages_py23_migration_test.py
@@ -0,0 +1,94 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.tag_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import tag_messages
+from absl.testing import absltest
+
+
+class TagMessagesPy23MigrationTest(absltest.TestCase):
+
+ def setUp(self):
+ super(TagMessagesPy23MigrationTest, self).setUp()
+
+ self.tag = tag_messages.Tag(
+ name='FAKE-NAME',
+ hidden=False,
+ color='FAKE-COLOR',
+ protect=True,
+ description='FAKE-DESCRIPTION',
+ urlsafe_key='FAKE-URL-KEY')
+
+ def assert_tag(self, item):
+ self.assertFalse(item.hidden)
+ self.assertTrue(item.protect)
+ self.assertEqual(item.name, 'FAKE-NAME')
+ self.assertEqual(item.color, 'FAKE-COLOR')
+ self.assertEqual(item.urlsafe_key, 'FAKE-URL-KEY')
+ self.assertEqual(item.description, 'FAKE-DESCRIPTION')
+
+ def testTag(self):
+ self.assert_tag(self.tag)
+
+ def testCreateTagRequest(self):
+ create_tag_req = tag_messages.CreateTagRequest(tag=self.tag)
+ self.assert_tag(create_tag_req.tag)
+
+ def testUpdateTagRequest(self):
+ update_tag_req = tag_messages.UpdateTagRequest(tag=self.tag)
+ self.assert_tag(update_tag_req.tag)
+
+ def testTagRequest(self):
+ tag_req = tag_messages.TagRequest(urlsafe_key='FAKE-URL-KEY')
+ self.assertEqual(tag_req.urlsafe_key, 'FAKE-URL-KEY')
+
+ def testListTagRequest(self):
+ list_tag_req = tag_messages.ListTagRequest(
+ page_size=50,
+ cursor='FAKE-CURSOR',
+ page_index=2,
+ include_hidden_tags=True)
+
+ self.assertEqual(list_tag_req.page_index, 2)
+ self.assertEqual(list_tag_req.page_size, 50)
+ self.assertTrue(list_tag_req.include_hidden_tags)
+ self.assertEqual(list_tag_req.cursor, 'FAKE-CURSOR')
+
+ def testListTagResponse(self):
+ list_tag_resp = tag_messages.ListTagResponse(
+ tags=[],
+ cursor='FAKE-CURSOR',
+ has_additional_results=True,
+ total_pages=20)
+
+ self.assertListEqual(list_tag_resp.tags, [])
+ self.assertEqual(list_tag_resp.total_pages, 20)
+ self.assertEqual(list_tag_resp.cursor, 'FAKE-CURSOR')
+ self.assertTrue(list_tag_resp.has_additional_results)
+
+ def testTagData(self):
+ tag_data = tag_messages.TagData(tag=None, more_info='FAKE-MORE-INFO')
+
+ self.assertIsNone(tag_data.tag)
+ self.assertEqual(tag_data.more_info, 'FAKE-MORE-INFO')
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/template_messages.py b/loaner/web_app/backend/api/messages/template_messages.py
new file mode 100644
index 00000000..8d34d34c
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/template_messages.py
@@ -0,0 +1,93 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Template messages for Template API."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from protorpc import messages
+
+
+class TemplateType(messages.Enum):
+ TITLE = 1
+ BODY = 2
+
+
+class Template(messages.Message):
+ """ConfigResponse response for ProtoRPC message.
+
+ Attributes:
+ name: str, The name of the name being requested.
+ body: str, the text of the body.
+ title: str, the subject line or title of the template.
+ """
+ name = messages.StringField(1)
+ body = messages.StringField(2)
+ title = messages.StringField(3)
+
+
+class ListTemplatesResponse(messages.Message):
+ """ListTemplatesResponse response for ProtoRPC message.
+
+ Attributes:
+ configs: TemplateResponse, The name and corresponding value being
+ returned.
+ """
+ templates = messages.MessageField(Template, 1, repeated=True)
+
+
+class UpdateTemplate(messages.Message):
+ """UpdateConfig request for ProtoRPC message.
+
+ Attributes:
+ name: str, The name of the name being requested.
+ body: str, the text of the body.
+ title: str, the subject line or title of the template.
+ """
+ name = messages.StringField(1)
+ body = messages.StringField(2)
+ title = messages.StringField(3)
+
+
+class UpdateTemplateRequest(messages.Message):
+ """UpdateTemplateRequest request for ProtoRPC message.
+
+ Attributes:
+ name: str, The name of the name being requested.
+ body: str, the text of the body.
+ title: str, the subject line or title of the template.
+ """
+ name = messages.StringField(1)
+ body = messages.StringField(2)
+ title = messages.StringField(3)
+
+
+class RemoveTemplateRequest(messages.Message):
+ """UpdateTemplateRequest request for ProtoRPC message.
+
+ Attributes:
+ name: The template to remove / delete.
+ """
+ name = messages.StringField(1)
+
+
+class CreateTemplateRequest(messages.Message):
+ """CreateTemplateRequest ProtoRPC message.
+
+ Attributes:
+ template: Template, A Template to create.
+ """
+ template = messages.MessageField(Template, 1)
diff --git a/loaner/web_app/backend/api/messages/template_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/template_messages_py23_migration_test.py
new file mode 100644
index 00000000..eff897ae
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/template_messages_py23_migration_test.py
@@ -0,0 +1,86 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.template_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import template_messages
+from absl.testing import absltest
+
+
+class TemplateMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testTemplateTypeTitle(self):
+ title_tmpl_type = template_messages.TemplateType(1)
+ self.assertEqual(title_tmpl_type.name, 'TITLE')
+
+ def testTemplateTypeBody(self):
+ body_tmpl_type = template_messages.TemplateType(2)
+ self.assertEqual(body_tmpl_type.name, 'BODY')
+
+ def testTemplate(self):
+ template = template_messages.Template(
+ name='TMPL-NAME',
+ body='TMPL-BODY-CONTENT',
+ title='TMPL-TITLE')
+
+ self.assertEqual(template.name, 'TMPL-NAME')
+ self.assertEqual(template.body, 'TMPL-BODY-CONTENT')
+ self.assertEqual(template.title, 'TMPL-TITLE')
+
+ def testListTemplatesResponse(self):
+ tmpls = [
+ template_messages.Template(name='TMPL-NAME-1'),
+ template_messages.Template(name='TMPL-NAME-2')
+ ]
+ list_tmpl_resp = template_messages.ListTemplatesResponse(templates=tmpls)
+
+ self.assertListEqual(list_tmpl_resp.templates, tmpls)
+
+ def testUpdateTemplate(self):
+ update_tmpl = template_messages.UpdateTemplate(
+ name='TMPL-NAME',
+ body='TMPL-BODY-CONTENTS',
+ title='TMPL-TITLE')
+
+ self.assertEqual(update_tmpl.name, 'TMPL-NAME')
+ self.assertEqual(update_tmpl.body, 'TMPL-BODY-CONTENTS')
+ self.assertEqual(update_tmpl.title, 'TMPL-TITLE')
+
+ def testUpdateTemplateRequest(self):
+ update_tmpl_req = template_messages.UpdateTemplateRequest(
+ name='TMPL-NAME',
+ body='TMPL-BODY-CONTENTS',
+ title='TMPL-TITLE')
+
+ self.assertEqual(update_tmpl_req.name, 'TMPL-NAME')
+ self.assertEqual(update_tmpl_req.body, 'TMPL-BODY-CONTENTS')
+ self.assertEqual(update_tmpl_req.title, 'TMPL-TITLE')
+
+ def testRemoveTemplateRequest(self):
+ remove_tmpl_req = template_messages.RemoveTemplateRequest(name='TMPL-NAME')
+ self.assertEqual(remove_tmpl_req.name, 'TMPL-NAME')
+
+ def testCreateTemplateRequest(self):
+ tmpl = template_messages.Template(name='TMPL-NAME')
+ create_tmpl_req = template_messages.CreateTemplateRequest(template=tmpl)
+ self.assertEqual(create_tmpl_req.template, tmpl)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/messages/user_messages.py b/loaner/web_app/backend/api/messages/user_messages.py
index fce5908b..d86fb6ea 100644
--- a/loaner/web_app/backend/api/messages/user_messages.py
+++ b/loaner/web_app/backend/api/messages/user_messages.py
@@ -57,3 +57,21 @@ class GetRoleRequest(messages.Message):
name: str, The role's name.
"""
name = messages.StringField(1, required=True)
+
+
+class ListRoleResponse(messages.Message):
+ """Returns all roles.
+
+ Attributes:
+ roles: a list of Roles.
+ """
+ roles = messages.MessageField(Role, 1, repeated=True)
+
+
+class DeleteRoleRequest(messages.Message):
+ """Deletes a role by name.
+
+ Attributes:
+ name: str, The role's name.
+ """
+ name = messages.StringField(1, required=True)
diff --git a/loaner/web_app/backend/api/messages/user_messages_py23_migration_test.py b/loaner/web_app/backend/api/messages/user_messages_py23_migration_test.py
new file mode 100644
index 00000000..1770637f
--- /dev/null
+++ b/loaner/web_app/backend/api/messages/user_messages_py23_migration_test.py
@@ -0,0 +1,68 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.api.messages.user_messages."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.api.messages import user_messages
+from absl.testing import absltest
+
+
+class UserMessagesPy23MigrationTest(absltest.TestCase):
+
+ def testUser(self):
+ user = user_messages.User(
+ email='fake@email.com',
+ roles=['FAKE-ROLE-1', 'FAKE-ROLE-2'],
+ permissions=['FAKE-PERMISSION-1', 'FAKE-PERMISSION-2'],
+ superadmin=True)
+
+ self.assertTrue(user.superadmin)
+ self.assertEqual(user.email, 'fake@email.com')
+ self.assertListEqual(user.roles, ['FAKE-ROLE-1', 'FAKE-ROLE-2'])
+ self.assertListEqual(
+ user.permissions, ['FAKE-PERMISSION-1', 'FAKE-PERMISSION-2'])
+
+ def testRole(self):
+ role = user_messages.Role(
+ name='FAKE-ROLE-NAME',
+ permissions=['FAKE-PERMISSION-1', 'FAKE-PERMISSION-2'],
+ associated_group='FAKE-ASSOCIATED-GROUP')
+
+ self.assertEqual(role.name, 'FAKE-ROLE-NAME')
+ self.assertEqual(role.associated_group, 'FAKE-ASSOCIATED-GROUP')
+ self.assertListEqual(
+ role.permissions, ['FAKE-PERMISSION-1', 'FAKE-PERMISSION-2'])
+
+ def testGetRoleRequest(self):
+ get_role_req = user_messages.GetRoleRequest(name='FAKE-ROLE-NAME')
+ self.assertEqual(get_role_req.name, 'FAKE-ROLE-NAME')
+
+ def testListRoleResponse(self):
+ role_1 = user_messages.Role(name='FAKE-ROLE-NAME-1')
+ role_2 = user_messages.Role(name='FAKE-ROLE-NAME-2')
+ list_role_resp = user_messages.ListRoleResponse(roles=[role_1, role_2])
+ self.assertListEqual(list_role_resp.roles, [role_1, role_2])
+
+ def testDeleteRoleRequest(self):
+ delete_role_req = user_messages.DeleteRoleRequest(name='FAKE-ROLE-NAME')
+ self.assertEqual(delete_role_req.name, 'FAKE-ROLE-NAME')
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/api/permissions.py b/loaner/web_app/backend/api/permissions.py
index ae1a9b69..d9677993 100644
--- a/loaner/web_app/backend/api/permissions.py
+++ b/loaner/web_app/backend/api/permissions.py
@@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""Define permissions for the app APIs.
To see actual permissions please check web_app/permissions.json.
@@ -24,6 +25,8 @@
import json
import os
+import six
+
# Run code on import.
class Permissions(object):
@@ -36,6 +39,6 @@ class Permissions(object):
with open(json_path) as f:
permissions_json = json.load(f)
-for key, value in permissions_json.iteritems():
+for key, value in six.iteritems(permissions_json):
setattr(Permissions, key, value)
- Permissions.ALL.append(value)
+ Permissions.ALL.append(str(value))
diff --git a/loaner/web_app/backend/api/search_api.py b/loaner/web_app/backend/api/search_api.py
index 7bda88ac..75a7734c 100644
--- a/loaner/web_app/backend/api/search_api.py
+++ b/loaner/web_app/backend/api/search_api.py
@@ -20,6 +20,8 @@
from protorpc import message_types
+from google.appengine.ext import deferred
+
from loaner.web_app.backend.api import auth
from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.api import root_api
@@ -42,9 +44,9 @@ class SearchApi(root_api.Service):
def clear(self, request):
"""Clears a search index for the given type."""
if request.model == search_messages.SearchIndexEnum.DEVICE:
- device_model.Device.clear_index()
+ deferred.defer(device_model.Device.clear_index)
elif request.model == search_messages.SearchIndexEnum.SHELF:
- shelf_model.Shelf.clear_index()
+ deferred.defer(shelf_model.Shelf.clear_index)
return message_types.VoidMessage()
@auth.method(
@@ -57,7 +59,7 @@ def clear(self, request):
def reindex(self, request):
"""Reindexes a search index for the given type."""
if request.model == search_messages.SearchIndexEnum.DEVICE:
- device_model.Device.index_entities_for_search()
+ deferred.defer(device_model.Device.index_entities_for_search)
elif request.model == search_messages.SearchIndexEnum.SHELF:
- shelf_model.Shelf.index_entities_for_search()
+ deferred.defer(shelf_model.Shelf.index_entities_for_search)
return message_types.VoidMessage()
diff --git a/loaner/web_app/backend/api/search_api_test.py b/loaner/web_app/backend/api/search_api_test.py
index c4be7ceb..79c0e966 100644
--- a/loaner/web_app/backend/api/search_api_test.py
+++ b/loaner/web_app/backend/api/search_api_test.py
@@ -23,6 +23,8 @@
from protorpc import message_types
+from google.appengine.ext import deferred
+
from loaner.web_app.backend.api import search_api
from loaner.web_app.backend.api.messages import search_messages
from loaner.web_app.backend.models import device_model
@@ -42,28 +44,32 @@ def tearDown(self):
self.service = None
@parameterized.parameters(
- (device_model.Device, search_messages.SearchIndexEnum.DEVICE),
- (shelf_model.Shelf, search_messages.SearchIndexEnum.SHELF),
+ (device_model.Device.clear_index,
+ search_messages.SearchIndexEnum.DEVICE),
+ (shelf_model.Shelf.clear_index,
+ search_messages.SearchIndexEnum.SHELF),
)
- def test_clear_index(self, test_model, test_enum):
+ def test_clear_index(self, expected_call, test_enum):
"""Test clearing the index of the shelves and devices."""
- with mock.patch.object(test_model, 'clear_index') as index_clear:
+ with mock.patch.object(deferred, 'defer') as mock_deferred:
request = search_messages.SearchMessage(model=test_enum)
response = self.service.clear(request)
self.assertIsInstance(response, message_types.VoidMessage)
- self.assertEqual(index_clear.call_count, 1)
+ mock_deferred.assert_called_once_with(expected_call)
@parameterized.parameters(
- (device_model.Device, search_messages.SearchIndexEnum.DEVICE),
- (shelf_model.Shelf, search_messages.SearchIndexEnum.SHELF),
+ (device_model.Device.index_entities_for_search,
+ search_messages.SearchIndexEnum.DEVICE),
+ (shelf_model.Shelf.index_entities_for_search,
+ search_messages.SearchIndexEnum.SHELF),
)
- def test_reindex(self, test_model, test_enum):
+ def test_reindex(self, expected_call, test_enum):
"""Test reindexing the shelves and devices."""
- with mock.patch.object(test_model, 'index_entities_for_search') as reindex:
+ with mock.patch.object(deferred, 'defer') as mock_deferred:
request = search_messages.SearchMessage(model=test_enum)
response = self.service.reindex(request)
self.assertIsInstance(response, message_types.VoidMessage)
- self.assertEqual(reindex.call_count, 1)
+ mock_deferred.assert_called_once_with(expected_call)
if __name__ == '__main__':
diff --git a/loaner/web_app/backend/api/shelf_api.py b/loaner/web_app/backend/api/shelf_api.py
index de3b892d..ea0ddc16 100644
--- a/loaner/web_app/backend/api/shelf_api.py
+++ b/loaner/web_app/backend/api/shelf_api.py
@@ -131,23 +131,19 @@ def update(self, request):
def list_shelves(self, request):
"""Lists enabled or all shelves based on any shelf attribute."""
self.check_xsrf_token(self.request_state)
- if request.page_size <= 0:
- raise endpoints.BadRequestException(
- 'The value for page_size must be greater than 0.')
query, sort_options, returned_fields = (
search_utils.set_search_query_options(request.query))
if not query:
query = search_utils.to_query(request, shelf_model.Shelf)
- offset = search_utils.calculate_page_offset(
- page_size=request.page_size, page_number=request.page_number)
-
+ cursor = search_utils.get_search_cursor(request.page_token)
search_results = shelf_model.Shelf.search(
query_string=query, query_limit=request.page_size,
- offset=offset, sort_options=sort_options,
+ cursor=cursor, sort_options=sort_options,
returned_fields=returned_fields)
- total_pages = search_utils.calculate_total_pages(
- page_size=request.page_size, total_results=search_results.number_found)
+ new_search_cursor = None
+ if search_results.cursor:
+ new_search_cursor = search_results.cursor.web_safe_string
shelves_messages = []
for document in search_results.results:
@@ -160,8 +156,8 @@ def list_shelves(self, request):
return shelf_messages.ListShelfResponse(
shelves=shelves_messages,
- total_results=search_results.number_found,
- total_pages=total_pages)
+ has_additional_results=bool(new_search_cursor),
+ page_token=new_search_cursor)
@auth.method(
shelf_messages.ShelfAuditRequest,
diff --git a/loaner/web_app/backend/api/shelf_api_test.py b/loaner/web_app/backend/api/shelf_api_test.py
index 7ef16858..9f7f6815 100644
--- a/loaner/web_app/backend/api/shelf_api_test.py
+++ b/loaner/web_app/backend/api/shelf_api_test.py
@@ -175,11 +175,6 @@ def test_list_shelves(self, request, response_length, mock_xsrf_token):
self.assertEqual(mock_xsrf_token.call_count, 1)
self.assertLen(response.shelves, response_length)
- def test_list_shelves_invalid_page_size(self):
- with self.assertRaises(endpoints.BadRequestException):
- request = shelf_messages.Shelf(page_size=0)
- self.service.list_shelves(request)
-
def test_list_shelves_with_search_constraints(self):
expressions = shared_messages.SearchExpression(expression='location')
expected_response = shelf_messages.ListShelfResponse(
@@ -188,7 +183,7 @@ def test_list_shelves_with_search_constraints(self):
shelf_request=shelf_messages.ShelfRequest(
location=self.shelf.location,
urlsafe_key=self.shelf.key.urlsafe()))],
- total_results=1, total_pages=1)
+ has_additional_results=False)
request = shelf_messages.Shelf(
query=shared_messages.SearchRequest(
query_string='location:NYC',
@@ -197,26 +192,19 @@ def test_list_shelves_with_search_constraints(self):
response = self.service.list_shelves(request)
self.assertEqual(response, expected_response)
- def test_list_shelves_with_offset(self):
- previouse_shelf_locations = []
- request = shelf_messages.Shelf(enabled=True, page_size=1, page_number=1)
- response = self.service.list_shelves(request)
- self.assertLen(response.shelves, 1)
- previouse_shelf_locations.append(response.shelves[0].location)
-
- # Get next page results and make sure it's not the same as last.
- request = shelf_messages.Shelf(enabled=True, page_size=1, page_number=2)
- response = self.service.list_shelves(request)
- self.assertLen(response.shelves, 1)
- self.assertNotIn(response.shelves[0], previouse_shelf_locations)
- previouse_shelf_locations.append(response.shelves[0].location)
-
- # Get next page results and make sure it's not the same as last 2.
- request = shelf_messages.Shelf(enabled=True, page_size=1, page_number=3)
- response = self.service.list_shelves(request)
- self.assertLen(response.shelves, 1)
- self.assertNotIn(response.shelves[0], previouse_shelf_locations)
- previouse_shelf_locations.append(response.shelves[0].location)
+ def test_list_shelves_with_page_token(self):
+ request = shelf_messages.Shelf(enabled=True, page_size=1)
+ response_shelves = []
+ while True:
+ response = self.service.list_shelves(request)
+ for shelf in response.shelves:
+ self.assertIn(shelf.location, self.shelf_locations)
+ response_shelves.append(shelf)
+ request = shelf_messages.Shelf(
+ enabled=True, page_size=1, page_token=response.page_token)
+ if not response.has_additional_results:
+ break
+ self.assertLen(response_shelves, 3)
@mock.patch('__main__.root_api.Service.check_xsrf_token')
@mock.patch('__main__.shelf_api.logging.info')
diff --git a/loaner/web_app/backend/api/tag_api.py b/loaner/web_app/backend/api/tag_api.py
index adb1e857..acc5e52d 100644
--- a/loaner/web_app/backend/api/tag_api.py
+++ b/loaner/web_app/backend/api/tag_api.py
@@ -48,15 +48,12 @@ def create(self, request):
"""Creates a new tag and inserts the instance into datastore."""
self.check_xsrf_token(self.request_state)
try:
- # The protect attribute will always be set to false because an
- # end-user will not have the ability to mark a tag as protected using the
- # API.
tag_model.Tag.create(
user_email=user.get_user_email(),
name=request.tag.name,
hidden=request.tag.hidden,
color=request.tag.color,
- protect=False,
+ protect=request.tag.protect,
description=request.tag.description)
except datastore_errors.BadValueError as err:
raise endpoints.BadRequestException(
@@ -74,8 +71,12 @@ def create(self, request):
def destroy(self, request):
"""Destroys a tag and removes all references via _pre_delete_hook method."""
self.check_xsrf_token(self.request_state)
- api_utils.get_ndb_key(urlsafe_key=request.urlsafe_key).delete()
-
+ key = api_utils.get_ndb_key(urlsafe_key=request.urlsafe_key)
+ tag = key.get()
+ if tag.protect:
+ raise endpoints.BadRequestException(
+ 'Cannot destroy tag %s because it is protected.' % tag.name)
+ key.delete()
return message_types.VoidMessage()
@auth.method(
@@ -87,10 +88,77 @@ def destroy(self, request):
def get(self, request):
"""Gets a tag by its urlsafe key."""
self.check_xsrf_token(self.request_state)
- tag = tag_model.Tag.get(request.urlsafe_key)
+ tag = api_utils.get_ndb_key(request.urlsafe_key).get()
return tag_messages.Tag(
name=tag.name,
hidden=tag.hidden,
color=tag.color,
protect=tag.protect,
description=tag.description)
+
+ @auth.method(
+ tag_messages.ListTagRequest,
+ tag_messages.ListTagResponse,
+ name='list',
+ path='list',
+ http_method='POST',
+ permission=permissions.Permissions.READ_CONFIGS)
+ def list(self, request):
+ """Lists tags in datastore."""
+ self.check_xsrf_token(self.request_state)
+
+ if request.page_size <= 0:
+ raise endpoints.BadRequestException(
+ 'The value for page size must be greater than 0.')
+
+ cursor = None
+ if request.cursor:
+ cursor = api_utils.get_datastore_cursor(urlsafe_cursor=request.cursor)
+
+ (tag_results, next_cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=request.page_size,
+ page_index=request.page_index,
+ include_hidden_tags=request.include_hidden_tags,
+ cursor=cursor)
+ tags_messages = []
+ for tag in tag_results:
+ message = tag_messages.Tag(
+ name=tag.name, hidden=tag.hidden, color=tag.color,
+ protect=tag.protect, description=tag.description,
+ urlsafe_key=tag.key.urlsafe())
+ tags_messages.append(message)
+
+ return tag_messages.ListTagResponse(
+ tags=tags_messages,
+ cursor=next_cursor.urlsafe() if next_cursor else None,
+ has_additional_results=has_additional_results,
+ total_pages=total_pages)
+
+ @auth.method(
+ tag_messages.UpdateTagRequest,
+ message_types.VoidMessage,
+ name='update',
+ path='update',
+ http_method='POST',
+ permission=permissions.Permissions.MODIFY_TAG)
+ def update(self, request):
+ """Updates an existing tag."""
+ self.check_xsrf_token(self.request_state)
+ key = api_utils.get_ndb_key(urlsafe_key=request.tag.urlsafe_key)
+ tag = key.get()
+ if tag.protect:
+ raise endpoints.BadRequestException(
+ 'Cannot update tag %s because it is protected.' % tag.name)
+ try:
+ tag.update(
+ user_email=user.get_user_email(),
+ name=request.tag.name,
+ hidden=request.tag.hidden,
+ protect=request.tag.protect,
+ color=request.tag.color,
+ description=request.tag.description)
+ except datastore_errors.BadValueError as err:
+ raise endpoints.BadRequestException(
+ 'Tag update failed due to: %s' % str(err))
+ return message_types.VoidMessage()
diff --git a/loaner/web_app/backend/api/tag_api_test.py b/loaner/web_app/backend/api/tag_api_test.py
index 6f87e238..51de807b 100644
--- a/loaner/web_app/backend/api/tag_api_test.py
+++ b/loaner/web_app/backend/api/tag_api_test.py
@@ -21,10 +21,13 @@
import mock
from protorpc import message_types
+from google.appengine.api import datastore_errors
+
import endpoints
from loaner.web_app.backend.api import tag_api
from loaner.web_app.backend.api.messages import tag_messages
+from loaner.web_app.backend.lib import api_utils
from loaner.web_app.backend.models import tag_model
from loaner.web_app.backend.testing import loanertest
@@ -40,6 +43,46 @@ def setUp(self):
self.test_tag = tag_model.Tag.create(
user_email=loanertest.USER_EMAIL, name='tag-one',
hidden=False, protect=False, color='amber')
+ self.test_tag_response = tag_messages.Tag(
+ name=self.test_tag.name,
+ hidden=self.test_tag.hidden,
+ protect=self.test_tag.protect,
+ color=self.test_tag.color,
+ description=self.test_tag.description,
+ urlsafe_key=self.test_tag.key.urlsafe())
+
+ self.default_tag = tag_model.Tag.create(
+ user_email=loanertest.USER_EMAIL, name='tag-visible-unprotected',
+ hidden=False, protect=False, color='blue')
+ self.default_tag_response = tag_messages.Tag(
+ name=self.default_tag.name,
+ hidden=self.default_tag.hidden,
+ protect=self.default_tag.protect,
+ color=self.default_tag.color,
+ description=self.default_tag.description,
+ urlsafe_key=self.default_tag.key.urlsafe())
+
+ self.hidden_tag = tag_model.Tag.create(
+ user_email=loanertest.USER_EMAIL, name='tag-hidden',
+ hidden=True, protect=False, color='red', description='test-description')
+ self.hidden_tag_response = tag_messages.Tag(
+ name=self.hidden_tag.name,
+ hidden=self.hidden_tag.hidden,
+ protect=self.hidden_tag.protect,
+ color=self.hidden_tag.color,
+ description=self.hidden_tag.description,
+ urlsafe_key=self.hidden_tag.key.urlsafe())
+
+ self.protected_tag = tag_model.Tag.create(
+ user_email=loanertest.USER_EMAIL, name='tag-protected',
+ hidden=False, protect=True, color='amber')
+ self.protected_tag_response = tag_messages.Tag(
+ name=self.protected_tag.name,
+ hidden=self.protected_tag.hidden,
+ protect=self.protected_tag.protect,
+ color=self.protected_tag.color,
+ description=self.protected_tag.description,
+ urlsafe_key=self.protected_tag.key.urlsafe())
def tearDown(self):
super(TagApiTest, self).tearDown()
@@ -47,7 +90,7 @@ def tearDown(self):
def test_create(self):
request = tag_messages.CreateTagRequest(tag=tag_messages.Tag(
- name='restricted_location', hidden=False, color='red',
+ name='restricted_location', hidden=False, protect=False, color='red',
description='leadership circle'))
with mock.patch.object(
self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
@@ -57,7 +100,7 @@ def test_create(self):
def test_create_defaults(self):
request = tag_messages.CreateTagRequest(tag=tag_messages.Tag(
- name='restricted_location', color='blue'))
+ name='restricted_location', color='blue', protect=False))
with mock.patch.object(
self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
response = self.service.create(request)
@@ -79,19 +122,25 @@ def test_create_prexisting_tag(self):
def test_destroy_tag(self):
request = tag_messages.TagRequest(
- urlsafe_key=self.test_tag.key.urlsafe())
+ urlsafe_key=self.hidden_tag.key.urlsafe())
with mock.patch.object(
self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
response = self.service.destroy(request)
self.assertEqual(mock_xsrf_token.call_count, 1)
self.assertIsNone(
- tag_model.Tag.get(self.test_tag.key.urlsafe()))
+ tag_model.Tag.get(self.hidden_tag.key.urlsafe()))
self.assertIsInstance(response, message_types.VoidMessage)
def test_destroy_not_existing(self):
- request = tag_messages.TagRequest(urlsafe_key='nonexistent_tag')
with self.assertRaises(endpoints.BadRequestException):
- self.service.destroy(request)
+ self.service.destroy(
+ tag_messages.TagRequest(urlsafe_key='nonexistent_tag'))
+
+ def test_destroy_protected(self):
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.destroy(
+ tag_messages.TagRequest(
+ urlsafe_key=self.protected_tag.key.urlsafe()))
def test_get_tag(self):
request = tag_messages.TagRequest(urlsafe_key=self.test_tag.key.urlsafe())
@@ -112,6 +161,176 @@ def test_get_tag_bad_request(self):
with self.assertRaises(endpoints.BadRequestException):
self.service.get(request)
+ def test_list_tags_include_hidden(self):
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.list(tag_messages.ListTagRequest(
+ page_size=tag_model.Tag.query().count(), include_hidden_tags=True))
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertListEqual(response.tags, [
+ self.test_tag_response, self.default_tag_response,
+ self.hidden_tag_response, self.protected_tag_response
+ ])
+ self.assertIsNotNone(response.cursor)
+ self.assertFalse(response.has_additional_results)
+ self.assertEqual(response.total_pages, 1)
+
+ def test_list_tags_exclude_hidden(self):
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.list(tag_messages.ListTagRequest(
+ page_size=tag_model.Tag.query().count(), include_hidden_tags=False))
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertNotIn(self.hidden_tag_response, response.tags)
+ self.assertIsNotNone(response.cursor)
+ self.assertEqual(response.total_pages, 1)
+
+ def test_list_tags_additional_results(self):
+ first_response = self.service.list(tag_messages.ListTagRequest(page_size=1))
+ self.assertListEqual(first_response.tags, [self.test_tag_response])
+ self.assertTrue(first_response.has_additional_results)
+ self.assertIsNotNone(first_response.cursor)
+ self.assertEqual(first_response.total_pages, 3)
+
+ second_response = self.service.list(tag_messages.ListTagRequest(
+ page_size=1, cursor=first_response.cursor))
+ self.assertListEqual(second_response.tags, [
+ self.default_tag_response])
+ self.assertTrue(second_response.has_additional_results)
+ self.assertIsNotNone(second_response.cursor)
+ self.assertEqual(second_response.total_pages, 3)
+
+ third_response = self.service.list(tag_messages.ListTagRequest(
+ page_size=1, cursor=second_response.cursor))
+ self.assertListEqual(third_response.tags, [self.protected_tag_response])
+ self.assertFalse(third_response.has_additional_results)
+ self.assertIsNotNone(third_response.cursor)
+ self.assertEqual(third_response.total_pages, 3)
+
+ def test_list_tags_first_page_index(self):
+ response = self.service.list(tag_messages.ListTagRequest(
+ page_size=1, page_index=1))
+ self.assertListEqual(response.tags, [self.test_tag_response])
+ self.assertTrue(response.has_additional_results)
+ self.assertIsNotNone(response.cursor)
+ self.assertEqual(response.total_pages, 3)
+
+ def test_list_tags_last_page_index(self):
+ response = self.service.list(tag_messages.ListTagRequest(
+ page_size=1, page_index=3))
+ self.assertListEqual(response.tags, [self.protected_tag_response])
+ self.assertFalse(response.has_additional_results)
+ self.assertIsNotNone(response.cursor)
+ self.assertEqual(response.total_pages, 3)
+
+ def test_list_tags_page_size_bad_request(self):
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.list(tag_messages.ListTagRequest(page_size=0))
+
+ def test_list_tags_none(self):
+ self.test_tag.key.delete()
+ self.default_tag.key.delete()
+ self.hidden_tag.key.delete()
+ self.protected_tag.key.delete()
+
+ response = self.service.list(tag_messages.ListTagRequest())
+ self.assertEmpty(response.tags)
+ self.assertFalse(response.has_additional_results)
+ self.assertIsNone(response.cursor)
+ self.assertEqual(response.total_pages, 0)
+
+ def test_list_tags_no_cursor(self):
+ with mock.patch.object(
+ api_utils, 'get_datastore_cursor',
+ autospec=True) as mock_get_datastore_cursor:
+ self.service.list(tag_messages.ListTagRequest())
+ self.assertFalse(mock_get_datastore_cursor.called)
+
+ def test_list_tags_cursor_bad_request(self):
+ with self.assertRaises(datastore_errors.BadValueError):
+ self.service.list(tag_messages.ListTagRequest(cursor='bad_cursor_value'))
+
+ def test_update(self):
+ new_color = 'blue'
+ new_description = 'An updated description.'
+ request = tag_messages.UpdateTagRequest(
+ tag=tag_messages.Tag(
+ urlsafe_key=self.test_tag.key.urlsafe(),
+ name=self.test_tag.name,
+ hidden=self.test_tag.hidden,
+ protect=self.test_tag.protect,
+ color=new_color,
+ description=new_description))
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.update(request)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertIsInstance(response, message_types.VoidMessage)
+ # Ensure that the new tag was updated.
+ tag = tag_model.Tag.get(self.test_tag.name)
+ self.assertEqual(tag.name, self.test_tag.name)
+ self.assertEqual(tag.hidden, self.test_tag.hidden)
+ self.assertEqual(tag.protect, self.test_tag.protect)
+ self.assertEqual(tag.color, new_color)
+ self.assertEqual(tag.description, new_description)
+
+ def test_update_rename(self):
+ """Tests updating a tag with a rename."""
+ new_name = 'A new tag name.'
+ request = tag_messages.UpdateTagRequest(
+ tag=tag_messages.Tag(
+ urlsafe_key=self.test_tag.key.urlsafe(),
+ name=new_name,
+ hidden=self.test_tag.hidden,
+ protect=self.test_tag.protect,
+ color=self.test_tag.color,
+ description=self.test_tag.description))
+ response = self.service.update(request)
+ self.assertIsInstance(response, message_types.VoidMessage)
+ tag = tag_model.Tag.get(self.test_tag.name)
+ self.assertEqual(tag.name, new_name)
+ self.assertEqual(tag.hidden, self.test_tag.hidden)
+ self.assertEqual(tag.protect, self.test_tag.protect)
+ self.assertEqual(tag.color, self.test_tag.color)
+ self.assertEqual(tag.description, self.test_tag.description)
+
+ def test_update_nonexistent(self):
+ """Tests updating a nonexistent tag."""
+ request = tag_messages.UpdateTagRequest(
+ tag=tag_messages.Tag(
+ urlsafe_key='nonexistent_urlsafe_key',
+ name='nonexistent tag',
+ hidden=False,
+ protect=False,
+ color='blue',
+ description=None))
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True):
+ with self.assertRaises(tag_api.endpoints.BadRequestException):
+ self.service.update(request)
+
+ def test_update_protected(self):
+ """Tests updating a nonexistent tag."""
+ request = tag_messages.UpdateTagRequest(
+ tag=tag_messages.Tag(
+ urlsafe_key=self.protected_tag.key.urlsafe(),
+ name=self.protected_tag.name,
+ hidden=self.protected_tag.hidden,
+ protect=self.protected_tag.protect,
+ color=self.protected_tag.color,
+ description='A new description for a protected tag.'))
+ with self.assertRaises(tag_api.endpoints.BadRequestException):
+ self.service.update(request)
+
+ def test_update_bad_request(self):
+ """Tests update raises BadRequestException with required fields missing."""
+ request = tag_messages.UpdateTagRequest(
+ tag=tag_messages.Tag(
+ urlsafe_key=self.test_tag.key.urlsafe(),
+ name='tag name'))
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.update(request)
+
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/api/template_api.py b/loaner/web_app/backend/api/template_api.py
new file mode 100644
index 00000000..addb5edf
--- /dev/null
+++ b/loaner/web_app/backend/api/template_api.py
@@ -0,0 +1,114 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""API endpoint that handles requests related to email templates for App."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from protorpc import message_types
+from google.appengine.api import datastore_errors
+
+import endpoints
+
+
+from loaner.web_app.backend.api import auth
+from loaner.web_app.backend.api import permissions
+from loaner.web_app.backend.api import root_api
+from loaner.web_app.backend.api.messages import template_messages
+from loaner.web_app.backend.models import template_model
+
+_FIELD_MISSING_MSG = 'Please double-check you provided all necessary fields.'
+
+
+@root_api.ROOT_API.api_class(
+ resource_name='template', path='template')
+class TemplateApi(root_api.Service):
+ """Endpoints API service class for Template resource."""
+
+ @auth.method(
+ message_types.VoidMessage,
+ template_messages.ListTemplatesResponse,
+ name='list',
+ path='list',
+ http_method='GET',
+ permission=permissions.Permissions.READ_CONFIGS)
+ def list(self, request):
+ """Gets a list of all template values."""
+ self.check_xsrf_token(self.request_state)
+ response_message = []
+ for template in template_model.Template.get_all():
+ response_message.append(template_messages.Template(
+ name=template.name,
+ body=template.body,
+ title=template.title))
+ return template_messages.ListTemplatesResponse(templates=response_message)
+
+ @auth.method(
+ template_messages.UpdateTemplateRequest,
+ message_types.VoidMessage,
+ name='update',
+ path='update',
+ http_method='POST',
+ permission=permissions.Permissions.MODIFY_CONFIG)
+
+ def update(self, request):
+ """Updates a given email template value."""
+ self.check_xsrf_token(self.request_state)
+ template = template_model.Template.get(request.name)
+ try:
+ template.update(
+ name=request.name, title=request.title, body=request.body)
+ except datastore_errors.BadValueError as err:
+ raise endpoints.BadRequestException(
+ 'Template update failed due to: %s' % err)
+ return message_types.VoidMessage()
+
+ @auth.method(
+ template_messages.RemoveTemplateRequest,
+ message_types.VoidMessage,
+ name='remove',
+ path='remove',
+ http_method='POST',
+ permission=permissions.Permissions.MODIFY_CONFIG)
+
+ def remove(self, request):
+ """Removes an email template given a name."""
+ self.check_xsrf_token(self.request_state)
+ try:
+ template = template_model.Template.get(request.name)
+ template.remove()
+ except KeyError as error:
+ raise endpoints.BadRequestException(str(error))
+ return message_types.VoidMessage()
+
+ @auth.method(
+ template_messages.CreateTemplateRequest,
+ message_types.VoidMessage,
+ name='create',
+ path='create',
+ http_method='POST',
+ permission=permissions.Permissions.MODIFY_CONFIG)
+ def create(self, request):
+ """Creates a new template and inserts the instance into datastore."""
+ self.check_xsrf_token(self.request_state)
+ try:
+ template_model.Template.create(
+ name=request.template.name,
+ title=request.template.title,
+ body=request.template.body)
+ except datastore_errors.BadValueError as err:
+ raise endpoints.BadRequestException(
+ 'Template creation failed due to: %s' % err)
+ return message_types.VoidMessage()
diff --git a/loaner/web_app/backend/api/template_api_test.py b/loaner/web_app/backend/api/template_api_test.py
new file mode 100644
index 00000000..f96b8a8e
--- /dev/null
+++ b/loaner/web_app/backend/api/template_api_test.py
@@ -0,0 +1,150 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Tests for backend.api.template_api."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from absl.testing import parameterized
+import mock
+
+from protorpc import message_types
+
+import endpoints
+
+from loaner.web_app.backend.api import root_api # pylint: disable=unused-import
+from loaner.web_app.backend.api import template_api
+from loaner.web_app.backend.api.messages import template_messages
+from loaner.web_app.backend.models import template_model # pylint: disable=unused-import
+from loaner.web_app.backend.testing import loanertest
+
+
+class TemplateApiTest(parameterized.TestCase, loanertest.EndpointsTestCase):
+ """Test for the Template API."""
+
+ def setUp(self):
+ super(TemplateApiTest, self).setUp()
+ self.service = template_api.TemplateApi()
+ self.login_admin_endpoints_user()
+ self.template_1 = template_model.Template(
+ id='this_template', body='template body 1', title='title')
+ self.template_2 = template_model.Template(
+ id='second_template', body='template body 2',
+ title='title 2')
+ self.template_1.put()
+ self.template_2.put()
+ self.template_list = template_model.Template.get_all()
+
+ def tearDown(self):
+ super(TemplateApiTest, self).tearDown()
+ self.service = None
+
+ def test_get_list_api(self):
+ response = self.service.list(message_types.VoidMessage())
+ self.assertEqual(
+ self.template_list[0].body,
+ response.templates[0].body)
+ self.assertEqual(
+ self.template_list[0].title,
+ response.templates[0].title)
+ self.assertEqual(
+ self.template_list[1].body,
+ response.templates[1].body)
+ self.assertEqual(
+ self.template_list[1].title,
+ response.templates[1].title)
+
+ def test_update_template_api(self):
+ request = template_messages.UpdateTemplateRequest(name='second_template',
+ body='test update',
+ title='update title')
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.update(request)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertIsInstance(response, message_types.VoidMessage)
+ template = template_model.Template.get('second_template')
+ self.assertEqual(
+ template.body,
+ 'test update')
+ self.assertEqual(
+ template.title,
+ 'update title')
+
+ def test_remove_template_api(self):
+ request = template_messages.RemoveTemplateRequest(name='second_template')
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.remove(request)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertIsInstance(response, message_types.VoidMessage)
+ template = template_model.Template.get('second_template')
+ self.assertIsNone(template)
+
+ def test_create(self):
+ request = template_messages.CreateTemplateRequest(
+ template=template_messages.Template(
+ name='test_create_template',
+ body='test create body',
+ title='test create title'))
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.create(request)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertIsInstance(response, message_types.VoidMessage)
+
+ def test_create_bad_request(self):
+ """Test create raises BadRequestException with required fields missing."""
+ request = template_messages.CreateTemplateRequest(
+ template=template_messages.Template(
+ name='',
+ body='',
+ title='test_title'))
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.create(request)
+
+ def test_update_bad_request(self):
+ """Tests update raises BadRequestException with required fields missing."""
+ request = template_messages.UpdateTemplateRequest(
+ name='this_template',
+ body='',
+ title='')
+ with self.assertRaises(endpoints.BadRequestException):
+ self.service.update(request)
+
+ def test_create_duplicate_name(self):
+ request = template_messages.CreateTemplateRequest(
+ template=template_messages.Template(
+ name='test_create_template',
+ body='test create body',
+ title='test create title'))
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ response = self.service.create(request)
+ self.assertEqual(mock_xsrf_token.call_count, 1)
+ self.assertIsInstance(response, message_types.VoidMessage)
+ request = template_messages.CreateTemplateRequest(
+ template=template_messages.Template(
+ name='test_create_template',
+ body='test second body',
+ title='test second title'))
+ with mock.patch.object(
+ self.service, 'check_xsrf_token', autospec=True) as mock_xsrf_token:
+ with self.assertRaises(endpoints.BadRequestException):
+ response = self.service.create(request)
+
+if __name__ == '__main__':
+ loanertest.main()
diff --git a/loaner/web_app/backend/api/user_api.py b/loaner/web_app/backend/api/user_api.py
index 3a6adabe..8c63fdbe 100644
--- a/loaner/web_app/backend/api/user_api.py
+++ b/loaner/web_app/backend/api/user_api.py
@@ -24,6 +24,7 @@
from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.api import root_api
from loaner.web_app.backend.api.messages import user_messages
+from loaner.web_app.backend.lib import api_utils
from loaner.web_app.backend.lib import user as user_lib
from loaner.web_app.backend.models import user_model
@@ -99,3 +100,34 @@ def update(self, request):
permissions=request.permissions,
associated_group=request.associated_group)
return message_types.VoidMessage()
+
+ @auth.method(
+ message_types.VoidMessage,
+ user_messages.ListRoleResponse,
+ name='list',
+ path='list',
+ http_method='POST',
+ permission=permissions.Permissions.READ_ROLES)
+ def list(self, request):
+ """List roles in datastore."""
+ self.check_xsrf_token(self.request_state)
+ response = user_messages.ListRoleResponse()
+ all_roles = user_model.Role.list_all_roles()
+ response.roles = [
+ api_utils.build_role_message_from_model(role) for role in all_roles
+ ]
+ return response
+
+ @auth.method(
+ user_messages.DeleteRoleRequest,
+ message_types.VoidMessage,
+ name='delete',
+ path='delete',
+ http_method='POST',
+ permission=permissions.Permissions.MODIFY_ROLE)
+ def delete(self, request):
+ """Delete a role from the datastore."""
+ self.check_xsrf_token(self.request_state)
+ role = user_model.Role.get_by_name(request.name)
+ role.destroy()
+ return message_types.VoidMessage()
diff --git a/loaner/web_app/backend/api/user_api_test.py b/loaner/web_app/backend/api/user_api_test.py
index 41660a8e..194107c0 100644
--- a/loaner/web_app/backend/api/user_api_test.py
+++ b/loaner/web_app/backend/api/user_api_test.py
@@ -22,6 +22,7 @@
from loaner.web_app.backend.api import user_api
from loaner.web_app.backend.api.messages import user_messages
+from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import loanertest
@@ -31,6 +32,8 @@ class UserApiTest(loanertest.EndpointsTestCase):
def setUp(self):
super(UserApiTest, self).setUp()
self.service = user_api.UserApi()
+ # Set bootstrap to completed so that maintenance mode will not be invoked.
+ config_model.Config.set('bootstrap_completed', True)
def tearDown(self):
super(UserApiTest, self).tearDown()
@@ -117,6 +120,27 @@ def test_update(self):
self.assertEqual(
created_role.associated_group, retrieved_role.associated_group)
+ def test_list(self):
+ created_role = user_model.Role.create(
+ name='test',
+ role_permissions=['get', 'put'],
+ associated_group=loanertest.TECHNICAL_ADMIN_EMAIL)
+
+ retrieved_role = self.service.list(message_types.VoidMessage())
+
+ self.assertEqual(created_role.name, retrieved_role.roles[0].name)
+ self.assertEqual(len(retrieved_role.roles), 1)
+
+ def test_delete(self):
+ user_model.Role.create(
+ name='test',
+ role_permissions=['get', 'put'],
+ associated_group=loanertest.TECHNICAL_ADMIN_EMAIL)
+
+ response = self.service.delete(user_messages.DeleteRoleRequest(name='test'))
+
+ self.assertIsInstance(response, message_types.VoidMessage)
+
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/clients/BUILD b/loaner/web_app/backend/clients/BUILD
index 9c7aadc0..2f428d64 100644
--- a/loaner/web_app/backend/clients/BUILD
+++ b/loaner/web_app/backend/clients/BUILD
@@ -1,14 +1,14 @@
# Description:
# BUILD file for //loaner/web_app/backend/clients.
-package(default_visibility = ["//loaner:__subpackages__"])
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(default_visibility = ["//loaner:__subpackages__"])
+
# ==============================================================================
# Libraries
# ==============================================================================
diff --git a/loaner/web_app/backend/clients/bigquery.py b/loaner/web_app/backend/clients/bigquery.py
index 9f6744b0..4a7893d3 100644
--- a/loaner/web_app/backend/clients/bigquery.py
+++ b/loaner/web_app/backend/clients/bigquery.py
@@ -41,6 +41,13 @@
'GeoPtProperty': 'STRING',
}
+DEVICE_QUERY = (""" SELECT *
+ FROM {dataset}.{table}
+ WHERE entity.serial_number = "{serial}"
+ LIMIT 20 """).format(dataset=constants.BIGQUERY_DATASET_NAME,
+ table=constants.BIGQUERY_DEVICE_TABLE,
+ serial='{}') # Serial will be added later.
+
class Error(Exception):
"""Base error class for this module."""
@@ -73,7 +80,8 @@ def __init__(self):
if constants.ON_LOCAL:
return
self._client = bigquery.Client()
- self._dataset = self._client.dataset(constants.BIGQUERY_DATASET_NAME)
+ self._dataset_ref = bigquery.DatasetReference(
+ self._client.project, constants.BIGQUERY_DATASET_NAME)
def initialize_tables(self):
"""Performs first-time setup by creating dataset/tables."""
@@ -82,18 +90,19 @@ def initialize_tables(self):
return
logging.info('Beginning BigQuery initialization.')
+ dataset = bigquery.Dataset(self._dataset_ref)
try:
- self._dataset.create()
+ dataset = self._client.create_dataset(dataset)
except cloud.exceptions.Conflict:
- logging.warning(
- 'Dataset %s already exists, not creating.', self._dataset.name)
+ logging.warning('Dataset %s already exists, not creating.',
+ dataset.dataset_id)
else:
- logging.info('Dataset %s successfully created.', self._dataset.name)
+ logging.info('Dataset %s successfully created.', dataset.dataset_id)
self._create_table(constants.BIGQUERY_DEVICE_TABLE, device_model.Device())
self._create_table(constants.BIGQUERY_SHELF_TABLE, shelf_model.Shelf())
- self._create_table(
- constants.BIGQUERY_SURVEY_TABLE, survey_models.Question())
+ self._create_table(constants.BIGQUERY_SURVEY_TABLE,
+ survey_models.Question())
logging.info('BigQuery successfully initialized.')
@@ -104,23 +113,23 @@ def _create_table(self, table_name, entity_instance):
table_name: str, name of the table to be created or updated.
entity_instance: an ndb.Model entity instance to base the schema on.
"""
- table = self._dataset.table(table_name)
+ table_ref = bigquery.TableReference(self._dataset_ref, table_name)
entity_schema = _generate_entity_schema(entity_instance)
table_schema = _generate_schema(entity_schema)
- table.schema = table_schema
+ table = bigquery.Table(table_ref, schema=table_schema)
try:
- table.create()
+ table = self._client.create_table(table)
except cloud.exceptions.Conflict:
- logging.info(
- 'Table %s already exists, attempting to update it.', table_name)
- table.reload()
+ logging.info('Table %s already exists, attempting to update it.',
+ table_name)
merged_schema = _merge_schemas(table.schema, table_schema)
- table.patch(schema=merged_schema)
+ table.schema = merged_schema
+ table = self._client.update_table(table, ['schema'])
logging.info('Table %s updated.', table_name)
else:
logging.info('Table %s created.', table_name)
- def stream_table(self, table_name, table):
+ def stream_table(self, table_name, table_data):
"""Inserts table rows into BigQuery.
For each row in a given table, we include a row_id, which is derived
@@ -131,7 +140,7 @@ def stream_table(self, table_name, table):
Args:
table_name: str, table name to stream to.
- table: List[tuple], rows for the insert request to the BigQuery API.
+ table_data: List[tuple], rows for the insert request to the BigQuery API.
Raises:
GetTableError: if an invalid table is passed in or the table is not
@@ -142,20 +151,30 @@ def stream_table(self, table_name, table):
logging.debug('On local, not connecting to BQ.')
return
- bq_table = self._dataset.table(table_name)
-
- if not bq_table.exists():
+ table_ref = self._dataset_ref.table(table_name)
+ try:
+ bq_table = self._client.get_table(table_ref)
+ except cloud.exceptions.NotFound:
raise GetTableError(
- 'Table {} does not exist or is not initialized'.format(table))
- bq_table.reload()
- # A row_id is comprised of each row's ndb key, timestamp, actor, and method.
- row_ids = [str(row[:5]) for row in table]
- errors = bq_table.insert_data(table, row_ids=row_ids)
+ 'Table {} does not exist or is not initialized'.format(table_name))
+ errors = self._client.insert_rows(bq_table, table_data)
if errors:
logging.error('BigQuery insert generated errors.')
logging.error(errors)
raise InsertError('BigQuery insert generated errors {}.'.format(errors))
+ def get_device_info(self, serial):
+ """Return historical data of a device by quering serial number.
+
+ Args:
+ serial: str, input used to query the data. An attribute of a device.
+
+ Returns:
+ List of tuples with historical data.
+ """
+ query_job = self._client.query(DEVICE_QUERY.format(serial))
+ return [row for row in query_job]
+
def _generate_entity_schema(entity):
"""Converts an ndb.Model to a BigQuery schema.
@@ -187,12 +206,13 @@ def _generate_entity_schema(entity):
try:
nested_entity = ndb_property._modelclass() # pylint: disable=protected-access
except TypeError:
- logging.warning(
- 'Could not create instance of %s, skipping.', property_name)
+ logging.warning('Could not create instance of %s, skipping.',
+ property_name)
continue
generated_schema = _generate_entity_schema(nested_entity)
- schema.append(bigquery.SchemaField(
- property_name, 'RECORD', field_type, fields=generated_schema))
+ schema.append(
+ bigquery.SchemaField(
+ property_name, 'RECORD', field_type, fields=generated_schema))
else:
bigquery_type = NDB_TO_BIGQUERY_TYPE.get(ndb_type)
if not bigquery_type:
@@ -212,7 +232,7 @@ def _generate_schema(entity_fields=None):
Args:
entity_fields: list of bigquery.SchemaField objects, the fields to include
- in the entity record.
+ in the entity record.
Returns:
A list of bigquery.SchemaField objects.
@@ -298,10 +318,11 @@ def _merge_schemas(current_fields, new_fields):
elif current_field.fields:
merged_fields = _merge_schemas(current_field.fields, new_field.fields)
current_fields.remove(current_field)
- current_fields.append(bigquery.SchemaField(
- current_field.name,
- 'RECORD',
- current_field.mode,
- fields=merged_fields))
+ current_fields.append(
+ bigquery.SchemaField(
+ current_field.name,
+ 'RECORD',
+ current_field.mode,
+ fields=merged_fields))
return current_fields
diff --git a/loaner/web_app/backend/clients/bigquery_test.py b/loaner/web_app/backend/clients/bigquery_test.py
index 070dfedb..13b68bc0 100644
--- a/loaner/web_app/backend/clients/bigquery_test.py
+++ b/loaner/web_app/backend/clients/bigquery_test.py
@@ -32,7 +32,6 @@
from google.appengine.ext import ndb
# pylint: enable=g-bad-import-order
-from loaner.web_app import constants
from loaner.web_app.backend.clients import bigquery
from loaner.web_app.backend.models import bigquery_row_model
from loaner.web_app.backend.models import device_model
@@ -47,14 +46,17 @@ def setUp(self):
bq_patcher = mock.patch.object(gcloud_bq, 'Client', autospec=True)
self.addCleanup(bq_patcher.stop)
self.bq_mock = bq_patcher.start()
- self.dataset = mock.Mock()
- self.table = mock.Mock()
+ self.dataset_ref = mock.Mock(spec=gcloud_bq.DatasetReference)
+ self.table = mock.Mock(spec=gcloud_bq.Table)
self.table.schema = []
- self.table.exists.return_value = True
- self.table.insert_data.return_value = None
- self.dataset.table.return_value = self.table
- self.client = bigquery.BigQueryClient()
- self.client._dataset = self.dataset
+ self.dataset_ref.table.return_value = self.table
+ with mock.patch.object(
+ bigquery.BigQueryClient, '__init__', return_value=None):
+ self.client = bigquery.BigQueryClient()
+ self.client._client = self.bq_mock()
+ self.client._dataset_ref = self.dataset_ref
+ self.client._client.insert_rows.return_value = None
+ self.client._client.get_table.return_value = self.table
self.nested_schema = [
gcloud_bq.SchemaField('nested_string_attribute', 'STRING', 'NULLABLE')]
self.entity_schema = [
@@ -81,62 +83,55 @@ def setUp(self):
@mock.patch.object(bigquery, '_generate_schema')
def test_initialize_tables(self, mock_schema):
- with mock.patch.object(bigquery, 'bigquery'):
- mock_client = bigquery.BigQueryClient()
- mock_client._dataset = mock.Mock()
-
- mock_client.initialize_tables()
-
- mock_schema.assert_called()
- mock_client._dataset.create.assert_called()
- mock_client._dataset.table.called_with(constants.BIGQUERY_DEVICE_TABLE)
- mock_client._dataset.table.called_with(constants.BIGQUERY_SHELF_TABLE)
-
- def test_create_table(self):
- self.table.create.side_effect = cloud.exceptions.Conflict('Exist')
- self.client._create_table(
- constants.BIGQUERY_DEVICE_TABLE, device_model.Device())
- self.assertEqual(self.table.create.call_count, 1)
- self.assertEqual(self.table.reload.call_count, 1)
- self.assertEqual(self.table.patch.call_count, 1)
-
- @mock.patch.object(bigquery, 'bigquery')
+ self.client.initialize_tables()
+
+ mock_schema.assert_called()
+ # Using assert foo.called here because assert_called() breaks here
+ # in OSS and I'll be honest I'm sick of trying to debug it.
+ assert self.client._client.create_dataset.called
+ assert self.client._client.create_table.called
+
@mock.patch.object(
bigquery, '_generate_schema', return_value=mock.Mock())
- def test_initialize_tables__dataset_exists(self, mock_schema, unused):
- del unused
- mock_client = bigquery.BigQueryClient()
- mock_client._dataset = mock.Mock()
- mock_client._dataset.create.side_effect = cloud.exceptions.Conflict(
+ @mock.patch.object(bigquery.BigQueryClient, '_create_table')
+ def test_initialize_tables__dataset_exists(self, mock_table, mock_schema):
+ self.client._client.create_dataset.side_effect = cloud.exceptions.Conflict(
'Already Exists: Dataset Loaner')
- mock_client.initialize_tables()
+ with mock.patch.object(gcloud_bq, 'Dataset') as mock_dataset:
+ mock_dataset.dataset_id = 'test'
+ self.client.initialize_tables()
- mock_schema.assert_called()
- mock_client._dataset.create.assert_called()
+ mock_table.assert_called()
+ assert self.client._client.create_dataset.called
def test_stream_table(self):
self.client.stream_table('Device', self.test_table)
- row_id = str((self.test_row_dict['ndb_key'],
- self.test_row_dict['timestamp'],
- self.test_row_dict['actor'],
- self.test_row_dict['method'],
- self.test_row_dict['summary']))
- self.table.insert_data.assert_called_once_with(
- self.test_table, row_ids=[row_id])
+ self.client._client.insert_rows.assert_called_once_with(
+ self.table, self.test_table)
def test_stream_row_no_table(self):
- self.table.exists.return_value = False
+ self.client._client.get_table.side_effect = cloud.exceptions.NotFound(
+ 'Table does not exist')
self.assertRaises(
bigquery.GetTableError,
self.client.stream_table, 'Device', self.test_table)
def test_stream_row_bq_errors(self):
- self.table.insert_data.return_value = 'Oh no it exploded'
+ self.client._client.insert_rows.return_value = 'Oh no it exploded'
self.assertRaises(
bigquery.InsertError,
self.client.stream_table, 'Device', self.test_table)
+ def test_get_device_info(self):
+ test_serial = 'ABC1234'
+ expected_results = [('ABC1234', 'test@', '0000')]
+ self.client._client.query.return_value = expected_results
+
+ results = self.client.get_device_info(test_serial)
+
+ self.assertEqual(results, expected_results)
+
def test_generate_schema_no_entity(self):
generated_schema = bigquery._generate_schema()
diff --git a/loaner/web_app/backend/common/BUILD b/loaner/web_app/backend/common/BUILD
index dcd625cc..5979e298 100644
--- a/loaner/web_app/backend/common/BUILD
+++ b/loaner/web_app/backend/common/BUILD
@@ -1,17 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/common.
+load(
+ "//loaner:builddefs.bzl",
+ "loaner_appengine_library",
+ "loaner_appengine_test",
+)
+
package(
default_visibility = [
"//loaner:__subpackages__",
],
)
-load(
- "//loaner:builddefs.bzl",
- "loaner_appengine_library",
-)
-
# ==============================================================================
# Libraries
# ==============================================================================
@@ -41,3 +42,29 @@ loaner_appengine_library(
"@requests_toolbelt_archive//:requests_toolbelt",
],
)
+
+# PY3 Migration Tests
+# =========================================================
+
+loaner_appengine_test(
+ name = "fake_monotonic_test",
+ srcs = [
+ "fake_monotonic_test.py",
+ ],
+ deps = [
+ ":fake_monotonic",
+ "@absl_archive//absl/testing:absltest",
+ ],
+)
+
+loaner_appengine_test(
+ name = "google_cloud_lib_fixer_test",
+ srcs = [
+ "google_cloud_lib_fixer_test.py",
+ ],
+ deps = [
+ ":google_cloud_lib_fixer",
+ "@absl_archive//absl/testing:absltest",
+ "@mock_archive//:mock",
+ ],
+)
diff --git a/loaner/web_app/backend/common/fake_monotonic_test.py b/loaner/web_app/backend/common/fake_monotonic_test.py
new file mode 100644
index 00000000..162a41ab
--- /dev/null
+++ b/loaner/web_app/backend/common/fake_monotonic_test.py
@@ -0,0 +1,37 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.common.fake_monotonic."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.common import fake_monotonic
+from absl.testing import absltest
+
+
+class FakeMonotonicTest(absltest.TestCase):
+
+ def testMonotonic(self):
+ start_time = fake_monotonic._LAST_TICK
+
+ new_time = fake_monotonic.monotonic()
+
+ self.assertGreaterEqual(new_time, start_time)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/common/google_cloud_lib_fixer_test.py b/loaner/web_app/backend/common/google_cloud_lib_fixer_test.py
new file mode 100644
index 00000000..eebca0b8
--- /dev/null
+++ b/loaner/web_app/backend/common/google_cloud_lib_fixer_test.py
@@ -0,0 +1,47 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.common.google_cloud_lib_fixer."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import sys
+import warnings
+
+import mock
+from requests_toolbelt.adapters import appengine
+
+from absl.testing import absltest
+
+from loaner.web_app.backend.common import fake_monotonic
+
+
+class GoogleCloudLibFixerTest(absltest.TestCase):
+
+ def testGoogleCloudLibFixer(self):
+ with mock.patch.object(appengine, 'monkeypatch') as monkeypatch_mock:
+ with mock.patch.object(warnings, 'filterwarnings') as filterwarnings_mock:
+ # The test subject is imported there as it is a script by nature.
+ from loaner.web_app.backend.common import google_cloud_lib_fixer # pylint: disable=g-import-not-at-top, unused-variable
+ monkeypatch_mock.assert_called_once_with()
+ filterwarnings_mock.assert_called_once_with(
+ 'ignore', message=r'urllib3 is using URLFetch.*')
+ self.assertEqual(fake_monotonic, sys.modules['monotonic'])
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/handlers/BUILD b/loaner/web_app/backend/handlers/BUILD
index b5cb5715..c53d7fee 100644
--- a/loaner/web_app/backend/handlers/BUILD
+++ b/loaner/web_app/backend/handlers/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/handlers.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -34,8 +34,10 @@ loaner_appengine_library(
],
deps = [
"//loaner/web_app:constants",
+ "//loaner/web_app/backend/api:permissions",
"//loaner/web_app/backend/lib:bootstrap",
"//loaner/web_app/backend/lib:sync_users",
+ "//loaner/web_app/backend/models:user_model",
"@absl_archive//absl/logging",
],
)
@@ -50,6 +52,7 @@ loaner_appengine_library(
],
deps = [
"//loaner/web_app:constants",
+ "//loaner/web_app/backend/lib:bootstrap",
],
)
@@ -64,9 +67,11 @@ loaner_appengine_test(
],
deps = [
":frontend",
+ "//loaner/web_app/backend/api:permissions",
"//loaner/web_app/backend/clients:directory",
"//loaner/web_app/backend/lib:bootstrap",
"//loaner/web_app/backend/models:config_model",
+ "//loaner/web_app/backend/models:user_model",
"//loaner/web_app/backend/testing:handlertest",
"@mock_archive//:mock",
],
@@ -80,6 +85,7 @@ loaner_appengine_test(
deps = [
":maintenance",
"//loaner/web_app:constants",
+ "//loaner/web_app/backend/lib:bootstrap",
"//loaner/web_app/backend/testing:handlertest",
"@mock_archive//:mock",
],
diff --git a/loaner/web_app/backend/handlers/cron/BUILD b/loaner/web_app/backend/handlers/cron/BUILD
index 0069a29c..4b14ad31 100644
--- a/loaner/web_app/backend/handlers/cron/BUILD
+++ b/loaner/web_app/backend/handlers/cron/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/handlers/cron.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -20,12 +20,24 @@ load(
loaner_appengine_library(
name = "cron",
srcs = [
+ ":cloud_datastore_export",
":run_custom_events",
":run_reminder_events",
":sync_user_roles",
],
)
+loaner_appengine_library(
+ name = "cloud_datastore_export",
+ srcs = [
+ "cloud_datastore_export.py",
+ ],
+ deps = [
+ "//loaner/web_app:constants",
+ "//loaner/web_app/backend/models:config_model",
+ ],
+)
+
loaner_appengine_library(
name = "run_custom_events",
srcs = [
@@ -79,6 +91,22 @@ loaner_appengine_library(
# Tests
# ==============================================================================
+loaner_appengine_test(
+ name = "cloud_datastore_export_test",
+ srcs = [
+ "cloud_datastore_export_test.py",
+ ],
+ deps = [
+ ":cloud_datastore_export",
+ "//loaner/web_app:constants",
+ "//loaner/web_app/backend/models:config_model",
+ "//loaner/web_app/backend/testing:handlertest",
+ "@absl_archive//absl/testing:parameterized",
+ "@freezegun_archive//:freezegun",
+ "@mock_archive//:mock",
+ ],
+)
+
loaner_appengine_test(
name = "run_custom_events_test",
srcs = [
diff --git a/loaner/web_app/backend/handlers/cron/cloud_datastore_export.py b/loaner/web_app/backend/handlers/cron/cloud_datastore_export.py
new file mode 100644
index 00000000..749d4f0f
--- /dev/null
+++ b/loaner/web_app/backend/handlers/cron/cloud_datastore_export.py
@@ -0,0 +1,97 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Module for exporting a backup of Datstore to GCP bucket in a cron job."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import datetime
+import httplib
+import json
+import logging
+import webapp2
+
+from google.appengine.api import app_identity
+from google.appengine.api import urlfetch
+
+from loaner.web_app import constants
+from loaner.web_app.backend.models import config_model
+
+_DATASTORE_API_URL = 'https://datastore.googleapis.com/v1/projects/%s:export'
+_DESTINATION_URL = 'gs://{}/{}_datastore_backup'
+
+
+class DatastoreExport(webapp2.RequestHandler):
+ """Handler for exporting Datastore to GCP bucket."""
+
+ def get(self):
+ bucket_name = config_model.Config.get('gcp_cloud_storage_bucket')
+ if config_model.Config.get('enable_backups') and bucket_name:
+ access_token, _ = app_identity.get_access_token(
+ 'https://www.googleapis.com/auth/datastore')
+
+ # We strip the first 2 characters because os.environ.get returns the
+ # application id with a partitiona separated by tilde, eg `s~`, which is
+ # not needed here.
+ app_id = constants.APPLICATION_ID.split('~')[1]
+
+ request = {
+ 'project_id': app_id,
+ 'output_url_prefix': _format_full_path(bucket_name),
+ }
+ headers = {
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer ' + access_token
+ }
+
+ logging.info(
+ 'Attempting to export cloud datastore to bucket %r.', bucket_name)
+ try:
+ result = urlfetch.fetch(
+ url=_DATASTORE_API_URL % app_id,
+ payload=json.dumps(request),
+ method=urlfetch.POST,
+ deadline=60,
+ headers=headers)
+ if result.status_code == httplib.OK:
+ logging.info('Cloud Datastore export completed.')
+ logging.info(result.content)
+ elif result.status_code >= 500:
+ logging.error(result.content)
+ else:
+ logging.warning(result.content)
+ self.response.status_int = result.status_code
+ except urlfetch.Error:
+ logging.error('Failed to initiate datastore export.')
+ self.response.status_int = httplib.INTERNAL_SERVER_ERROR
+ else:
+ logging.info('Backups are not enabled, skipping.')
+
+
+def _format_full_path(bucket_name):
+ """Formats the full output URL with proper datetime stamp.
+
+ Args:
+ bucket_name: str, the Google Cloud Storage bucket name.
+
+ Returns:
+ A formatted string URL.
+ """
+ if bucket_name.startswith('gs://'):
+ bucket_name = bucket_name[5:]
+
+ return _DESTINATION_URL.format(
+ bucket_name, datetime.datetime.now().strftime('%Y_%m_%d-%H%M%S'))
diff --git a/loaner/web_app/backend/handlers/cron/cloud_datastore_export_test.py b/loaner/web_app/backend/handlers/cron/cloud_datastore_export_test.py
new file mode 100644
index 00000000..45855a90
--- /dev/null
+++ b/loaner/web_app/backend/handlers/cron/cloud_datastore_export_test.py
@@ -0,0 +1,126 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Tests for backend.handlers.cron.cloud_datastore_export."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import datetime
+import httplib
+import json
+import logging
+
+from absl.testing import parameterized
+import freezegun
+import mock
+
+from google.appengine.api import app_identity
+from google.appengine.api import urlfetch
+
+from loaner.web_app import constants
+from loaner.web_app.backend.handlers.cron import cloud_datastore_export
+from loaner.web_app.backend.models import config_model
+from loaner.web_app.backend.testing import handlertest
+
+
+class DatastoreExportTest(parameterized.TestCase, handlertest.HandlerTestCase):
+
+ _CRON_URL = '/_cron/cloud_datastore_export'
+
+ def setUp(self):
+ super(DatastoreExportTest, self).setUp()
+ self.testbed.init_app_identity_stub()
+ self.testbed.init_urlfetch_stub()
+ self.test_application_id = 'test_application_id'
+ # Adding `s~` here because os.environ.get returns the application id with
+ # a partition followed by the tilde character.
+ constants.APPLICATION_ID = 's~' + self.test_application_id
+
+ @mock.patch.object(logging, 'info')
+ @mock.patch.object(
+ app_identity, 'get_access_token', return_value=('mock_token', None))
+ @mock.patch.object(urlfetch, 'fetch')
+ @mock.patch.object(config_model.Config, 'get')
+ def test_get(
+ self, mock_config, mock_urlfetch, mock_app_identity, mock_logging):
+ test_destination_url = cloud_datastore_export._DESTINATION_URL
+ test_bucket_name = 'gcp_bucket_name'
+ mock_config.side_effect = [test_bucket_name, True]
+ expected_url = (
+ cloud_datastore_export._DATASTORE_API_URL % self.test_application_id)
+ mock_urlfetch.return_value.status_code = httplib.OK
+ now = datetime.datetime(
+ year=2017, month=1, day=1, hour=1, minute=1, second=15)
+ with freezegun.freeze_time(now):
+ self.testapp.get(self._CRON_URL)
+ mock_urlfetch.assert_called_once_with(
+ url=expected_url,
+ payload=json.dumps({
+ 'project_id': self.test_application_id,
+ 'output_url_prefix': test_destination_url.format(
+ test_bucket_name, now.strftime('%Y_%m_%d-%H%M%S'))
+ }),
+ method=urlfetch.POST,
+ deadline=60,
+ headers={
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer mock_token'})
+ self.assertEqual(mock_logging.call_count, 3)
+
+ @mock.patch.object(logging, 'info')
+ @mock.patch.object(config_model.Config, 'get', return_value=False)
+ def test_get_backups_not_enabled(self, mock_config, mock_logging):
+ self.testapp.get(self._CRON_URL)
+ mock_logging.assert_called_once_with('Backups are not enabled, skipping.')
+
+ @mock.patch.object(urlfetch, 'fetch', side_effect=urlfetch.Error)
+ @mock.patch.object(config_model.Config, 'get')
+ def test_get_urlfetch_error(self, mock_config, mock_urlfetch):
+ mock_config.side_effect = ['gcp_bucket_name', True]
+ response = self.testapp.get(self._CRON_URL, expect_errors=True)
+ self.assertEqual(response.status_int, httplib.INTERNAL_SERVER_ERROR)
+
+ @parameterized.named_parameters(
+ ('>= 500', httplib.NOT_IMPLEMENTED, 0, 1),
+ ('unknown', httplib.METHOD_NOT_ALLOWED, 1, 0),
+ )
+ @mock.patch.object(cloud_datastore_export, 'logging')
+ @mock.patch.object(urlfetch, 'fetch')
+ @mock.patch.object(config_model.Config, 'get', return_value=False)
+ def test_get_status_code(
+ self, status_code, warning_count, error_count, mock_config,
+ mock_urlfetch, mock_logging):
+ mock_config.side_effect = ['test_bucket_name', True]
+ mock_urlfetch.return_value.status_code = status_code
+ self.testapp.get(self._CRON_URL, expect_errors=True)
+ self.assertEqual(mock_logging.error.call_count, error_count)
+ self.assertEqual(mock_logging.warning.call_count, warning_count)
+
+ @parameterized.named_parameters(
+ ('bucket_with_prefix', 'gs://test_bucket'),
+ ('bucket_without_prefix', 'test_bucket'),
+ )
+ def test_format_full_path(self, mock_bucket):
+ now = datetime.datetime(
+ year=2017, month=1, day=1, hour=1, minute=1, second=15)
+ with freezegun.freeze_time(now):
+ self.assertEqual(
+ cloud_datastore_export._format_full_path(mock_bucket),
+ 'gs://test_bucket/2017_01_01-010115_datastore_backup')
+
+
+if __name__ == '__main__':
+ handlertest.main()
diff --git a/loaner/web_app/backend/handlers/frontend.py b/loaner/web_app/backend/handlers/frontend.py
index 5b668619..db9e774b 100644
--- a/loaner/web_app/backend/handlers/frontend.py
+++ b/loaner/web_app/backend/handlers/frontend.py
@@ -28,8 +28,10 @@
from google.appengine.api import users
from loaner.web_app import constants
+from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.lib import bootstrap
from loaner.web_app.backend.lib import sync_users
+from loaner.web_app.backend.models import user_model
if os.environ.get('TEST_WORKSPACE') == 'gng':
# The following mocks are here to stub out the npm compiled frontend since
@@ -77,7 +79,12 @@ def get(self, path):
if self.bootstrap_completed:
self.redirect(path)
else:
- self.redirect(BOOTSTRAP_URL)
+ datastore_user = user_model.User.get_user(user.email())
+ if (permissions.Permissions.BOOTSTRAP in
+ datastore_user.get_permissions()):
+ self.redirect(BOOTSTRAP_URL)
+ else:
+ self.redirect('/maintenance')
def _serve_frontend(self):
"""Writes Angular Frontend to the response and sets the right content type.
diff --git a/loaner/web_app/backend/handlers/frontend_test.py b/loaner/web_app/backend/handlers/frontend_test.py
index 85efafc9..5ec61f64 100644
--- a/loaner/web_app/backend/handlers/frontend_test.py
+++ b/loaner/web_app/backend/handlers/frontend_test.py
@@ -22,10 +22,12 @@
import mock
from loaner.web_app import constants
+from loaner.web_app.backend.api import permissions
from loaner.web_app.backend.clients import directory # pylint: disable=unused-import
from loaner.web_app.backend.handlers import frontend
from loaner.web_app.backend.lib import bootstrap # pylint: disable=unused-import
from loaner.web_app.backend.models import config_model
+from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import handlertest
@@ -110,7 +112,18 @@ def setUp(self, *args, **kwargs):
super(FrontendHandlerTestIncomplete, self).setUp(*args, **kwargs)
- def test_load(self):
+ @mock.patch.object(user_model, 'User')
+ def test_load_regular_user(self, mock_user_class):
+ mock_user = mock_user_class.get_user.return_value
+ mock_user.get_permissions.return_value = []
+ self.testapp.get(r'/')
+ self.mock_redirect.assert_called_once_with('/maintenance')
+
+ @mock.patch.object(user_model, 'User')
+ def test_load_admin_user(self, mock_user_class):
+ mock_user = mock_user_class.get_user.return_value
+ mock_user.get_permissions.return_value = [
+ permissions.Permissions.BOOTSTRAP]
self.testapp.get(r'/')
self.mock_redirect.assert_called_once_with('/bootstrap')
@@ -160,7 +173,11 @@ def setUp(self, *args, **kwargs):
super(FrontendHandlerTestChangeBootstrapStatus, self).setUp(*args, **kwargs)
- def test_load(self):
+ @mock.patch.object(user_model, 'User')
+ def test_load(self, mock_user_class):
+ mock_user = mock_user_class.get_user.return_value
+ mock_user.get_permissions.return_value = [
+ permissions.Permissions.BOOTSTRAP]
self.testapp.get(r'/')
config_model.Config.set('bootstrap_completed', True)
config_model.Config.set('bootstrap_started', True)
diff --git a/loaner/web_app/backend/handlers/maintenance.py b/loaner/web_app/backend/handlers/maintenance.py
index f5d6e8d6..e4c5365c 100644
--- a/loaner/web_app/backend/handlers/maintenance.py
+++ b/loaner/web_app/backend/handlers/maintenance.py
@@ -21,6 +21,7 @@
import webapp2
from loaner.web_app import constants
+from loaner.web_app.backend.lib import bootstrap
class MaintenanceHandler(webapp2.RequestHandler):
@@ -28,7 +29,10 @@ class MaintenanceHandler(webapp2.RequestHandler):
def get(self):
"""Process GET, serving a static maintenance page."""
- self.response.headers['Content-Type'] = 'text/html'
- self.response.body_file.write(
- constants.JINJA.get_template('maintenance.html').render(
- {'app_name': constants.APP_NAME}))
+ if constants.MAINTENANCE or not bootstrap.is_bootstrap_completed():
+ self.response.headers['Content-Type'] = 'text/html'
+ self.response.body_file.write(
+ constants.JINJA.get_template('maintenance.html').render(
+ {'app_name': constants.APP_NAME}))
+ else:
+ self.redirect('/user')
diff --git a/loaner/web_app/backend/handlers/maintenance_test.py b/loaner/web_app/backend/handlers/maintenance_test.py
index 72067eb0..f400585f 100644
--- a/loaner/web_app/backend/handlers/maintenance_test.py
+++ b/loaner/web_app/backend/handlers/maintenance_test.py
@@ -22,14 +22,16 @@
import mock
from loaner.web_app import constants
+from loaner.web_app.backend.lib import bootstrap
constants.MAINTENANCE = True
# constants.MAINTENANCE before import main; pylint: disable=g-import-not-at-top
from loaner.web_app.backend.testing import handlertest
class MaintenanceHandlerTest(handlertest.HandlerTestCase):
+ """Tests the handler when all traffic should be served to static page."""
- def test_get(self):
+ def test_get_constants_maintenance_set(self):
"""Test handler for GET."""
with mock.patch.object(
jinja2.Environment, 'get_template') as mock_get_template:
@@ -39,5 +41,31 @@ def test_get(self):
mock_get_template.assert_called_once_with('maintenance.html')
+constants.MAINTENANCE = False
+# Reimport handlertest to set constants.MAINTENANCE to false this time; pylint: disable=g-import-not-at-top, reimported
+from loaner.web_app.backend.testing import handlertest
+
+
+class MaintenanceHandlerUpdateTest(handlertest.HandlerTestCase):
+ """Tests the handler when serving traffic during application updates."""
+
+ @mock.patch.object(bootstrap, 'is_bootstrap_completed', return_value=False)
+ def test_get_during_app_updates(self, mock_is_bootstrap_started):
+ """Test handler for GET while application is being updated."""
+ with mock.patch.object(
+ jinja2.Environment, 'get_template') as mock_get_template:
+ response = self.testapp.get('/maintenance')
+ self.assertEqual(response.status_int, 200)
+ self.assertEqual(response.content_type, 'text/html')
+ mock_get_template.assert_called_once_with('maintenance.html')
+
+ @mock.patch.object(bootstrap, 'is_bootstrap_completed', return_value=True)
+ def test_get_no_app_updates(self, mock_is_bootstrap_started):
+ """Test handler for GET while application is not being being updated."""
+ response = self.testapp.get('/maintenance')
+ self.assertEqual(response.status_int, 302)
+ self.assertIn('/user', response.location)
+
+
if __name__ == '__main__':
handlertest.main()
diff --git a/loaner/web_app/backend/handlers/task/BUILD b/loaner/web_app/backend/handlers/task/BUILD
index f8ea2c04..4e4ad8a5 100644
--- a/loaner/web_app/backend/handlers/task/BUILD
+++ b/loaner/web_app/backend/handlers/task/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/handlers/task.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -21,6 +21,7 @@ loaner_appengine_library(
name = "task",
srcs = [
":process_action",
+ ":process_emails",
":stream_to_bigquery",
],
)
@@ -36,6 +37,13 @@ loaner_appengine_library(
],
)
+loaner_appengine_library(
+ name = "process_emails",
+ srcs = [
+ "process_emails.py",
+ ],
+)
+
loaner_appengine_library(
name = "stream_to_bigquery",
srcs = [
@@ -64,6 +72,17 @@ loaner_appengine_test(
],
)
+loaner_appengine_test(
+ name = "process_emails_test",
+ srcs = [
+ "process_emails_test.py",
+ ],
+ deps = [
+ "//loaner/web_app/backend/testing:handlertest",
+ "@mock_archive//:mock",
+ ],
+)
+
loaner_appengine_test(
name = "stream_to_bigquery_test",
srcs = [
diff --git a/loaner/web_app/backend/handlers/task/process_emails.py b/loaner/web_app/backend/handlers/task/process_emails.py
new file mode 100644
index 00000000..abd39218
--- /dev/null
+++ b/loaner/web_app/backend/handlers/task/process_emails.py
@@ -0,0 +1,42 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Module for processing the email task queues."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import logging
+import webapp2
+
+from google.appengine.api import mail
+
+
+class EmailTaskHandler(webapp2.RequestHandler):
+ """A task to send out an email."""
+
+ def post(self):
+ """Processes POST request."""
+ kwargs = self.request.params.items()
+ email_dict = {}
+ for key, value in kwargs:
+ email_dict[key] = value
+
+ try:
+ mail.send_mail(**email_dict)
+ except mail.InvalidEmailError as error:
+ logging.error(
+ 'Email helper failed to send mail due to an error: %s. (Kwargs: %s)',
+ error.message, kwargs)
diff --git a/loaner/web_app/backend/handlers/task/process_emails_test.py b/loaner/web_app/backend/handlers/task/process_emails_test.py
new file mode 100644
index 00000000..51ab5be8
--- /dev/null
+++ b/loaner/web_app/backend/handlers/task/process_emails_test.py
@@ -0,0 +1,52 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Tests for backend.handlers.task.process_emails."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import logging
+import mock
+
+from google.appengine.api import mail
+
+from loaner.web_app.backend.testing import handlertest
+
+
+class ReminderTest(handlertest.HandlerTestCase):
+
+ @mock.patch.object(mail, 'send_mail', autospec=True)
+ def test_post(self, mock_gae_send_email):
+ request = {
+ 'sender': 'no-reply@example.com',
+ 'to': 'sample_user',
+ 'subject': 'Thank you for using Grab and Go!',
+ 'body': 'Thank you for returning your device.',
+ }
+ response = self.testapp.post('/_ah/queue/send-email', request)
+ self.assertEqual(response.status_int, 200)
+
+ mock_gae_send_email.assert_called_once_with(**request)
+
+ @mock.patch.object(mail, 'send_mail', side_effect=mail.InvalidEmailError)
+ @mock.patch.object(logging, 'error')
+ def test_post_error(self, mock_logerror, mock_gae_sendmail):
+ self.testapp.post('/_ah/queue/send-email', expect_errors=True)
+ self.assertTrue(mock_logerror.called)
+
+
+if __name__ == '__main__':
+ handlertest.main()
diff --git a/loaner/web_app/backend/handlers/task/stream_to_bigquery.py b/loaner/web_app/backend/handlers/task/stream_to_bigquery.py
index b5e8b096..bb1a19ba 100644
--- a/loaner/web_app/backend/handlers/task/stream_to_bigquery.py
+++ b/loaner/web_app/backend/handlers/task/stream_to_bigquery.py
@@ -23,6 +23,7 @@
import webapp2
from google.appengine.ext import deferred
+from google.appengine.ext import ndb
from loaner.web_app.backend.models import bigquery_row_model
@@ -30,6 +31,12 @@
class StreamToBigQueryHandler(webapp2.RequestHandler):
"""Handler to add a row and stream to BigQuery if a threshold is reached."""
+ @ndb.transactional
+ def stream_rows_wrapper(self):
+ """Streams rows ensuring that it is transactional."""
+ deferred.defer(
+ bigquery_row_model.BigQueryRow.stream_rows, _transactional=True)
+
def post(self):
"""Adds a BigQuery row to Datastore and streams it using a deferred task.
@@ -41,7 +48,7 @@ def post(self):
bigquery_row_model.BigQueryRow.add(**payload)
try:
if bigquery_row_model.BigQueryRow.threshold_reached():
- deferred.defer(bigquery_row_model.BigQueryRow.stream_rows)
+ self.stream_rows_wrapper()
else:
logging.info('Not streaming rows, thresholds not met.')
except Exception as e: # pylint: disable=broad-except
diff --git a/loaner/web_app/backend/lib/BUILD b/loaner/web_app/backend/lib/BUILD
index 54a9f7cf..3857b69e 100644
--- a/loaner/web_app/backend/lib/BUILD
+++ b/loaner/web_app/backend/lib/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/lib.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -48,7 +48,9 @@ loaner_appengine_library(
deps = [
"//loaner/web_app/backend/api/messages:device_messages",
"//loaner/web_app/backend/api/messages:shelf_messages",
- "//loaner/web_app/backend/models:device_model",
+ "//loaner/web_app/backend/api/messages:tag_messages",
+ "//loaner/web_app/backend/api/messages:user_messages",
+ "//loaner/web_app/backend/models:tag_model",
"@endpoints_archive//:endpoints",
],
)
@@ -62,11 +64,12 @@ loaner_appengine_library(
"bootstrap.yaml",
],
deps = [
+ ":datastore_yaml",
+ ":user",
+ ":utils",
"//loaner/web_app:constants",
"//loaner/web_app/backend/clients:bigquery",
"//loaner/web_app/backend/clients:directory",
- "//loaner/web_app/backend/lib:datastore_yaml",
- "//loaner/web_app/backend/lib:utils",
"//loaner/web_app/backend/models:bootstrap_status_model",
"//loaner/web_app/backend/models:config_model",
],
@@ -107,6 +110,7 @@ loaner_appengine_library(
deps = [
"//loaner/web_app/backend/api/messages:shared_messages",
"//loaner/web_app/backend/models:device_model",
+ "@endpoints_archive//:endpoints",
],
)
@@ -197,8 +201,12 @@ loaner_appengine_test(
"//loaner/web_app:constants",
"//loaner/web_app/backend/api/messages:device_messages",
"//loaner/web_app/backend/api/messages:shelf_messages",
+ "//loaner/web_app/backend/api/messages:tag_messages",
+ "//loaner/web_app/backend/api/messages:user_messages",
"//loaner/web_app/backend/models:device_model",
"//loaner/web_app/backend/models:shelf_model",
+ "//loaner/web_app/backend/models:tag_model",
+ "//loaner/web_app/backend/models:user_model",
"//loaner/web_app/backend/testing:loanertest",
"@absl_archive//absl/testing:parameterized",
"@endpoints_archive//:endpoints",
@@ -212,8 +220,9 @@ loaner_appengine_test(
],
deps = [
":bootstrap",
+ ":datastore_yaml",
+ "//loaner/web_app:constants",
"//loaner/web_app/backend/clients:bigquery",
- "//loaner/web_app/backend/lib:datastore_yaml",
"//loaner/web_app/backend/lib:utils",
"//loaner/web_app/backend/models:bootstrap_status_model",
"//loaner/web_app/backend/models:config_model",
@@ -271,6 +280,7 @@ loaner_appengine_test(
"//loaner/web_app/backend/models:shelf_model",
"//loaner/web_app/backend/testing:loanertest",
"@absl_archive//absl/testing:parameterized",
+ "@endpoints_archive//:endpoints",
"@mock_archive//:mock",
],
)
diff --git a/loaner/web_app/backend/lib/api_utils.py b/loaner/web_app/backend/lib/api_utils.py
index 834b493f..26b27b6a 100644
--- a/loaner/web_app/backend/lib/api_utils.py
+++ b/loaner/web_app/backend/lib/api_utils.py
@@ -26,7 +26,9 @@
from loaner.web_app.backend.api.messages import device_messages
from loaner.web_app.backend.api.messages import shelf_messages
-from loaner.web_app.backend.models import device_model
+from loaner.web_app.backend.api.messages import tag_messages
+from loaner.web_app.backend.api.messages import user_messages
+from loaner.web_app.backend.models import tag_model
_CORRUPT_KEY_MSG = 'The key provided for submission was not found.'
_MALFORMED_PAGE_TOKEN_MSG = 'The page token provided is incorrect.'
@@ -73,10 +75,20 @@ def build_device_message_from_model(device, guest_permitted):
message.next_reminder = build_reminder_message_from_model(
device.next_reminder)
if device.is_assigned:
- message.max_extend_date = device_model.calculate_return_dates(
- device.assignment_date).max
+ message.max_extend_date = device.return_dates.max
if device.shelf:
message.shelf = build_shelf_message_from_model(device.shelf.get())
+ for tag_data in device.tags:
+ tag_data_message = tag_messages.TagData()
+ urlsafe_key = tag_model.Tag.get(tag_data.tag.name).key.urlsafe()
+ tag_data_message.tag = tag_messages.Tag(
+ name=tag_data.tag.name, hidden=tag_data.tag.hidden,
+ color=tag_data.tag.color, protect=tag_data.tag.protect,
+ description=tag_data.tag.description,
+ urlsafe_key=urlsafe_key)
+ tag_data_message.more_info = tag_data.more_info
+ message.tags.append(tag_data_message)
+
return message
@@ -95,6 +107,21 @@ def build_reminder_message_from_model(reminder):
count=reminder.count)
+def build_role_message_from_model(role):
+ """Builds a role ProtoRPC message.
+
+ Args:
+ role: user_model.Role, the role for a user.
+
+ Returns:
+ A role_messages.Role message with the respective properties.
+ """
+ return user_messages.Role(
+ name=role.name,
+ permissions=role.permissions,
+ associated_group=role.associated_group)
+
+
def build_shelf_message_from_model(shelf):
"""Builds a shelf_messages.Shelf ProtoRPC message.
@@ -117,6 +144,7 @@ def build_shelf_message_from_model(shelf):
capacity=shelf.capacity,
audit_notification_enabled=shelf.audit_notification_enabled,
audit_requested=shelf.audit_requested,
+ audit_enabled=shelf.audit_enabled,
responsible_for_audit=shelf.responsible_for_audit,
last_audit_time=shelf.last_audit_time,
last_audit_by=shelf.last_audit_by,
diff --git a/loaner/web_app/backend/lib/api_utils_test.py b/loaner/web_app/backend/lib/api_utils_test.py
index d4b17ac0..4af0aea0 100644
--- a/loaner/web_app/backend/lib/api_utils_test.py
+++ b/loaner/web_app/backend/lib/api_utils_test.py
@@ -29,9 +29,13 @@
from loaner.web_app import constants
from loaner.web_app.backend.api.messages import device_messages
from loaner.web_app.backend.api.messages import shelf_messages
+from loaner.web_app.backend.api.messages import tag_messages
+from loaner.web_app.backend.api.messages import user_messages
from loaner.web_app.backend.lib import api_utils
from loaner.web_app.backend.models import device_model
from loaner.web_app.backend.models import shelf_model
+from loaner.web_app.backend.models import tag_model
+from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import loanertest
@@ -39,6 +43,11 @@ class ApiUtilsTest(parameterized.TestCase, loanertest.TestCase):
def setUp(self):
super(ApiUtilsTest, self).setUp()
+ self.test_tag = tag_model.Tag(
+ name='test',
+ hidden=False,
+ protect=False,
+ color='red').put().get()
self.test_shelf_model = shelf_model.Shelf(
enabled=True,
friendly_name='test_friendly_name',
@@ -47,7 +56,7 @@ def setUp(self):
altitude=1.1,
capacity=10,
audit_interval_override=12,
- audit_notification_enabled=False,
+ audit_notification_enabled=True,
audit_requested=True,
responsible_for_audit='test_group',
last_audit_time=datetime.datetime(year=2018, month=1, day=1),
@@ -64,8 +73,9 @@ def setUp(self):
longitude=20.20,
altitude=1.1,
capacity=10,
- audit_notification_enabled=False,
+ audit_notification_enabled=True,
audit_requested=True,
+ audit_enabled=True,
responsible_for_audit='test_group',
last_audit_time=datetime.datetime(year=2018, month=1, day=1),
last_audit_by='test_auditer')
@@ -93,7 +103,8 @@ def test_build_device_message_from_model(self):
damaged_reason='Not damaged',
last_reminder=device_model.Reminder(level=1),
next_reminder=device_model.Reminder(level=2),
- ).put().get()
+ ).put().get()
+ test_device.associate_tag('test', self.test_tag.name)
expected_message = device_messages.Device(
serial_number='test_serial_value',
asset_tag='test_asset_tag_value',
@@ -118,10 +129,18 @@ def test_build_device_message_from_model(self):
next_reminder=device_messages.Reminder(level=2),
guest_permitted=True,
guest_enabled=True,
- max_extend_date=device_model.calculate_return_dates(
- test_device.assignment_date).max,
+ max_extend_date=test_device.return_dates.max,
overdue=True,
)
+ expected_tag = tag_messages.Tag(
+ name=self.test_tag.name,
+ hidden=self.test_tag.hidden,
+ protect=self.test_tag.protect,
+ color=self.test_tag.color,
+ urlsafe_key=self.test_tag.key.urlsafe())
+ expected_tag_data = tag_messages.TagData(tag=expected_tag)
+ expected_message.tags.append(expected_tag_data)
+
actual_message = api_utils.build_device_message_from_model(
test_device, True)
self.assertEqual(actual_message, expected_message)
@@ -148,6 +167,22 @@ def test_build_shelf_message_from_model(self):
self.test_shelf_model)
self.assertEqual(actual_message, self.expected_shelf_message)
+ def test_build_role_message_from_model(self):
+ """Test the construction of a role message from a role entity."""
+ test_role = user_model.Role(
+ key=ndb.Key(user_model.Role, 'test_role'),
+ permissions=['get', 'put'],
+ associated_group=loanertest.TECHNICAL_ADMIN_EMAIL).put().get()
+
+ expected_message = user_messages.Role(
+ name='test_role',
+ permissions=['get', 'put'],
+ associated_group=loanertest.TECHNICAL_ADMIN_EMAIL)
+
+ actual_message = api_utils.build_role_message_from_model(test_role)
+
+ self.assertEqual(actual_message, expected_message)
+
@parameterized.named_parameters(
{'testcase_name': 'with_lat_long', 'message': shelf_messages.Shelf(
location='NY', capacity=50, friendly_name='Big_Apple',
diff --git a/loaner/web_app/backend/lib/bootstrap.py b/loaner/web_app/backend/lib/bootstrap.py
index 1febad9e..546dc505 100644
--- a/loaner/web_app/backend/lib/bootstrap.py
+++ b/loaner/web_app/backend/lib/bootstrap.py
@@ -25,6 +25,8 @@
import os
import sys
+from distutils import version
+
from google.appengine.ext import deferred
from loaner.web_app import constants
@@ -44,6 +46,15 @@
'bootstrap_bq_history': 'Configuring datastore history tables in BigQuery',
'bootstrap_load_config_yaml': 'Loading config_defaults.yaml into datastore.'
}
+# Tasks that should only be run for a new deployment, i.e. they are destructive.
+_BOOTSTRAP_INIT_TASKS = (
+ 'bootstrap_datastore_yaml',
+ 'bootstrap_load_config_yaml'
+)
+# Tasks that should be run for an update or can rerun, i.e. they are idempotent.
+_BOOTSTRAP_UPDATE_TASKS = tuple(
+ set(_TASK_DESCRIPTIONS.keys()) - set(_BOOTSTRAP_INIT_TASKS)
+)
class Error(Exception):
@@ -153,15 +164,46 @@ def bootstrap_load_config_yaml(**kwargs):
config_model.Config.set(name, value, False)
-def get_all_bootstrap_functions():
- """Helper function that gets all functions starting with bootstrap_."""
- return {
- k: v
- for k, v in dict(
- inspect.getmembers(sys.modules[__name__], inspect.isfunction))
- .iteritems() if k.startswith('bootstrap_')
+def get_bootstrap_functions(get_all=False):
+ """Gets all functions necessary for bootstrap.
+
+ This function collects only the functions necessary for the bootstrap
+ process. Specifically, it will collect tasks specific to a new or existing
+ deployment (an update). Additionally, it will collect any failed tasks so that
+ they can be attempted again.
+
+ Args:
+ get_all: bool, return all bootstrap tasks, defaults to False.
+
+ Returns:
+ Dict, all functions necessary for bootstrap.
+ """
+ module_functions = inspect.getmembers(
+ sys.modules[__name__], inspect.isfunction)
+ bootstrap_functions = {
+ key: value
+ for key, value in dict(module_functions)
+ .iteritems() if key.startswith('bootstrap_')
}
+ if get_all or _is_new_deployment():
+ return bootstrap_functions
+
+ if is_update():
+ bootstrap_functions = {
+ key: value for key, value in bootstrap_functions.iteritems()
+ if key in _BOOTSTRAP_UPDATE_TASKS
+ }
+ else: # Collect all bootstrap functions that failed and all update tasks.
+ for function_name in bootstrap_functions.keys():
+ status_entity = bootstrap_status_model.BootstrapStatus.get_by_id(
+ function_name)
+ if (status_entity and
+ status_entity.success and
+ function_name not in _BOOTSTRAP_UPDATE_TASKS):
+ del bootstrap_functions[function_name]
+ return bootstrap_functions
+
def _run_function_as_task(all_functions_list, function_name, kwargs=None):
"""Runs a specific function and its kwargs as an AppEngine task.
@@ -190,62 +232,112 @@ def _run_function_as_task(all_functions_list, function_name, kwargs=None):
def run_bootstrap(requested_tasks=None):
- """Run one or more bootstrap functions.
+ """Runs one or more bootstrap functions.
Args:
requested_tasks: dict, wherein the keys are function names and the
values are keyword arg dicts. If no functions are passed, runs all
- bootstrap functions with no specific kwargs.
+ necessary bootstrap functions with no specific kwargs.
Returns:
A dictionary of started tasks, with the task names as keys and the values
being task descriptions as found in _TASK_DESCRIPTIONS.
-
- Raises:
- Error: If bootstrap is not enabled for this app.
"""
- if not constants.BOOTSTRAP_ENABLED:
- raise Error(
- 'Requested bootstrap method(s) disallowed. Change '
- 'constants.ENABLE_BOOTSTRAP to True to allow this.')
config_model.Config.set('bootstrap_started', True)
- all_bootstrap = get_all_bootstrap_functions()
+ bootstrap_functions = get_bootstrap_functions()
+
+ if _is_new_deployment():
+ logging.info('Running bootstrap for a new deployment.')
+ else:
+ logging.info(
+ 'Running bootstrap for an update from version %s to %s.',
+ config_model.Config.get('running_version'),
+ constants.APP_VERSION)
run_status_dict = {}
if requested_tasks:
for function_name, kwargs in requested_tasks.iteritems():
- _run_function_as_task(all_bootstrap, function_name, kwargs)
+ _run_function_as_task(bootstrap_functions, function_name, kwargs)
run_status_dict[function_name] = _TASK_DESCRIPTIONS.get(
function_name, function_name)
else:
logging.debug('Running all functions as no specific function was passed.')
- for function_name in all_bootstrap:
- _run_function_as_task(all_bootstrap, function_name)
+ for function_name in bootstrap_functions:
+ _run_function_as_task(bootstrap_functions, function_name)
run_status_dict[function_name] = _TASK_DESCRIPTIONS.get(
function_name, function_name)
return run_status_dict
+def _is_new_deployment():
+ """Checks whether this is a new deployment.
+
+ A '0.0' version number and a missing bootstrap_datastore_yaml task
+ status indicates that this is a new deployment. The latter check
+ is to support backward-compatibility with early alpha versions that did not
+ have a version number.
+
+ Returns:
+ True if this is a new deployment, else False.
+ """
+ return (config_model.Config.get('running_version') == '0.0' and
+ not bootstrap_status_model.BootstrapStatus.get_by_id(
+ 'bootstrap_datastore_yaml'))
+
+
+def _is_latest_version():
+ """Checks if the app is up to date and sets bootstrap to incomplete if not.
+
+ Checks whether the running version is the same as the deployed version as an
+ app that is not updated should trigger bootstrap moving back to an incomplete
+ state, thus signaling that certain tasks need to be run again.
+
+ Returns:
+ True if running matches deployed version and not a new install, else False.
+ """
+ if _is_new_deployment():
+ return False
+
+ up_to_date = version.LooseVersion(
+ constants.APP_VERSION) == version.LooseVersion(
+ config_model.Config.get('running_version'))
+
+ if not up_to_date and not is_bootstrap_started():
+ # Set the updates tasks to incomplete so that they run again.
+ config_model.Config.set('bootstrap_completed', False)
+ for task in _BOOTSTRAP_UPDATE_TASKS:
+ status_entity = bootstrap_status_model.BootstrapStatus.get_or_insert(task)
+ status_entity.success = False
+ status_entity.put()
+ return up_to_date
+
+
+def is_update():
+ """Checks whether the application is in a state requiring an update.
+
+ Returns:
+ True if an update is available and this is not a new installation.
+ """
+ if _is_new_deployment():
+ return False
+
+ return version.LooseVersion(constants.APP_VERSION) > version.LooseVersion(
+ config_model.Config.get('running_version'))
+
+
def is_bootstrap_completed():
"""Gets the general status of the app bootstrap.
- This first checks bootstrap_started, and if that is True it returns the value
- of bootstrap_completed.
+ Ensures that the latest version is running and that bootstrap has completed.
Returns:
True if the bootstrap is complete, else False.
"""
- try:
- if config_model.Config.get('bootstrap_started'):
- return config_model.Config.get(
- 'bootstrap_completed')
- else:
- return False
- except KeyError:
- return False
+ return (_is_latest_version() and
+ config_model.Config.get('bootstrap_completed'))
def is_bootstrap_started():
@@ -254,19 +346,18 @@ def is_bootstrap_started():
Returns:
True if the bootstrap has started, else False.
"""
+ if (config_model.Config.get('bootstrap_started') and
+ config_model.Config.get('bootstrap_completed')):
+ # If bootstrap was completed indicate that it is no longer in progress.
+ config_model.Config.set('bootstrap_started', False)
return config_model.Config.get('bootstrap_started')
-def is_bootstrap_enabled():
- """Checks if bootstrap is enabled in the configuration settings."""
- return constants.BOOTSTRAP_ENABLED
-
-
def get_bootstrap_task_status():
- """Gets the status of all bootstrap tasks.
+ """Gets the status of the bootstrap tasks.
- Additionally this sets the overall completion status if all tasks were
- successful.
+ Additionally, this sets the overall completion status if the tasks were
+ successful and sets the running version number after bootstrap completion.
Returns:
Dictionary with task names as the keys and values being sub-dictionaries
@@ -275,7 +366,7 @@ def get_bootstrap_task_status():
"""
bootstrap_completed = True
bootstrap_task_status = {}
- for function_name in get_all_bootstrap_functions():
+ for function_name in get_bootstrap_functions(get_all=True):
status_entity = bootstrap_status_model.BootstrapStatus.get_by_id(
function_name)
if status_entity:
@@ -284,5 +375,11 @@ def get_bootstrap_task_status():
bootstrap_task_status[function_name] = {}
if not bootstrap_task_status[function_name].get('success'):
bootstrap_completed = False
+ if bootstrap_completed:
+ config_model.Config.set(
+ 'running_version', constants.APP_VERSION)
+ logging.info(
+ 'Successfully bootstrapped application to version %s.',
+ constants.APP_VERSION)
config_model.Config.set('bootstrap_completed', bootstrap_completed)
return bootstrap_task_status
diff --git a/loaner/web_app/backend/lib/bootstrap.yaml b/loaner/web_app/backend/lib/bootstrap.yaml
index d2c75a15..048a865c 100644
--- a/loaner/web_app/backend/lib/bootstrap.yaml
+++ b/loaner/web_app/backend/lib/bootstrap.yaml
@@ -16,6 +16,10 @@
core_events:
+- name: device_audit
+ description: Event raised when a device is audited.
+ enabled: True
+
- name: device_loan_assign
description: Event run when a device is assigned.
enabled: True
diff --git a/loaner/web_app/backend/lib/bootstrap_test.py b/loaner/web_app/backend/lib/bootstrap_test.py
index 04fed948..c8a020b9 100644
--- a/loaner/web_app/backend/lib/bootstrap_test.py
+++ b/loaner/web_app/backend/lib/bootstrap_test.py
@@ -19,13 +19,16 @@
from __future__ import print_function
import datetime
+import logging
import os
import mock
-from google.appengine.ext import deferred # pylint: disable=unused-import
+from google.appengine.ext import deferred
+from loaner.web_app import constants
from loaner.web_app.backend.clients import bigquery
+from loaner.web_app.backend.clients import directory
from loaner.web_app.backend.lib import bootstrap
from loaner.web_app.backend.lib import datastore_yaml # pylint: disable=unused-import
from loaner.web_app.backend.lib import utils
@@ -37,10 +40,9 @@
class BootstrapTest(loanertest.TestCase):
"""Tests for the datastore YAML importer lib."""
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('google.appengine.ext.deferred.defer')
+ @mock.patch.object(deferred, 'defer', autospec=True)
def test_run_bootstrap(self, mock_defer):
- """Tests that run_bootstrap defers tasks for all four methods."""
+ """Tests that run_bootstrap defers tasks for 2 methods."""
mock_defer.return_value = 'fake-task'
self.assertFalse(config_model.Config.get(
'bootstrap_started'))
@@ -57,30 +59,47 @@ def test_run_bootstrap(self, mock_defer):
'bootstrap_datastore_yaml':
bootstrap._TASK_DESCRIPTIONS['bootstrap_datastore_yaml']})
self.assertEqual(len(mock_defer.mock_calls), 2)
- self.assertTrue(config_model.Config.get(
- 'bootstrap_started'))
+ self.assertTrue(config_model.Config.get('bootstrap_started'))
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('google.appengine.ext.deferred.defer')
+ @mock.patch.object(deferred, 'defer', autospec=True)
+ def test_run_bootstrap_update(self, mock_defer):
+ """Tests that run_bootstrap defers the correct tasks for an update."""
+ mock_defer.return_value = 'fake-task'
+ config_model.Config.set('running_version', '0.0.1-alpha')
+ # This bootstrap task being completed would indicate that this is an update.
+ bootstrap_status_model.BootstrapStatus.get_or_insert(
+ 'bootstrap_datastore_yaml').put()
+ self.assertFalse(config_model.Config.get('bootstrap_started'))
+ self.assertFalse(bootstrap._is_latest_version())
+ run_status_dict = bootstrap.run_bootstrap()
+ # Ensure that only _BOOTSTRAP_UPDATE_TASKS were run during an update.
+ update_task_descriptions = {
+ key: value for key, value in bootstrap._TASK_DESCRIPTIONS.iteritems()
+ if key in bootstrap._BOOTSTRAP_UPDATE_TASKS
+ }
+ self.assertDictEqual(run_status_dict, update_task_descriptions)
+ self.assertEqual(
+ len(mock_defer.mock_calls), len(update_task_descriptions))
+ self.assertTrue(config_model.Config.get('bootstrap_started'))
+
+ @mock.patch.object(deferred, 'defer', autospec=True)
def test_run_bootstrap_all_functions(self, mock_defer):
- """Tests that run_bootstrap defers tasks for all four methods."""
+ """Tests that run_bootstrap defers all tasks for a new deployment."""
mock_defer.return_value = 'fake-task'
self.assertFalse(config_model.Config.get(
'bootstrap_started'))
run_status_dict = bootstrap.run_bootstrap()
self.assertDictEqual(run_status_dict, bootstrap._TASK_DESCRIPTIONS)
- self.assertEqual(len(mock_defer.mock_calls), 4)
+ self.assertEqual(
+ len(mock_defer.mock_calls), len(bootstrap._TASK_DESCRIPTIONS))
self.assertTrue(config_model.Config.get(
'bootstrap_started'))
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', False)
- def test_run_bootstrap_while_disabled(self):
- """Tests that bootstrapping is disallowed when constant False."""
+ def test_run_bootstrap_bad_function(self):
with self.assertRaises(bootstrap.Error):
- bootstrap.run_bootstrap({'bootstrap_fake_method': {}})
+ bootstrap.run_bootstrap({'bootstrap_bad_function': {}})
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap.datastore_yaml.import_yaml')
+ @mock.patch.object(datastore_yaml, 'import_yaml', autospec=True)
def test_manage_task_being_called(self, mock_importyaml):
"""Tests that the manage_task decorator is doing its task management."""
del mock_importyaml # Unused.
@@ -91,10 +110,9 @@ def test_manage_task_being_called(self, mock_importyaml):
expected_model.description,
bootstrap._TASK_DESCRIPTIONS['bootstrap_datastore_yaml'])
self.assertTrue(expected_model.success)
- self.assertTrue(expected_model.timestamp < datetime.datetime.utcnow())
+ self.assertLess(expected_model.timestamp, datetime.datetime.utcnow())
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap.datastore_yaml.import_yaml')
+ @mock.patch.object(datastore_yaml, 'import_yaml', autospec=True)
def test_manage_task_handles_exception(self, mock_importyaml):
"""Tests that the manage_task decorator kandles an exception."""
mock_importyaml.side_effect = KeyError('task-exception')
@@ -105,10 +123,9 @@ def test_manage_task_handles_exception(self, mock_importyaml):
expected_model = bootstrap_status_model.BootstrapStatus.get_by_id(
'bootstrap_datastore_yaml')
self.assertFalse(expected_model.success)
- self.assertTrue(expected_model.timestamp < datetime.datetime.utcnow())
+ self.assertLess(expected_model.timestamp, datetime.datetime.utcnow())
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap.datastore_yaml.import_yaml')
+ @mock.patch.object(datastore_yaml, 'import_yaml', autospec=True)
def test_bootstrap_datastore_yaml(self, mock_importyaml):
"""Tests bootstrap_datastore_yaml."""
bootstrap.bootstrap_datastore_yaml(user_email='foo')
@@ -117,10 +134,9 @@ def test_bootstrap_datastore_yaml(self, mock_importyaml):
mock_importyaml.assert_called_once_with(
yaml_file_to_string, 'foo', True)
- @mock.patch('__main__.bootstrap.logging.info')
- @mock.patch('__main__.bootstrap.logging.warn')
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap.directory.DirectoryApiClient')
+ @mock.patch.object(logging, 'info', autospec=True)
+ @mock.patch.object(logging, 'warn', autospec=True)
+ @mock.patch.object(directory, 'DirectoryApiClient', autospec=True)
def test_bootstrap_chrome_ous(
self, mock_directoryclass, mock_logwarn, mock_loginfo):
mock_client = mock_directoryclass.return_value
@@ -139,13 +155,13 @@ def test_bootstrap_chrome_ous(
mock_client.reset_mock()
mock_client.get_org_unit.return_value = {'fake': 'response'}
bootstrap.bootstrap_chrome_ous(user_email='foo')
- mock_client.insert_org_unit.assert_not_called()
+ self.assertEqual(mock_client.insert_org_unit.call_count, 0)
mock_logwarn.assert_has_calls([
mock.call(bootstrap._ORG_UNIT_EXISTS_MSG, org_unit_name) for
org_unit_name in bootstrap.constants.ORG_UNIT_DICT
])
- @mock.patch.object(bigquery, 'BigQueryClient')
+ @mock.patch.object(bigquery, 'BigQueryClient', autospec=True)
def test_bootstrap_bq_history(self, mock_clientclass):
"""Tests bootstrap_bq_history."""
mock_client = mock.Mock()
@@ -166,29 +182,74 @@ def test_bootstrap_load_config_yaml(
mock.call('test_name', 'test_value', False),
mock.call('bootstrap_started', True, False)], any_order=True)
- def test_is_bootstrap_completed(self):
- """Tests is_bootstrap_completed under myriad circumstances."""
- self.assertFalse(bootstrap.is_bootstrap_completed())
-
- bootstrap.config_model.Config.set('bootstrap_started', True)
- self.assertFalse(bootstrap.is_bootstrap_completed())
+ def test_is_bootstrap_completed_true_up_to_date(self):
+ config_model.Config.set('bootstrap_completed', True)
+ config_model.Config.set('running_version', constants.APP_VERSION)
+ self.assertTrue(bootstrap.is_bootstrap_completed())
- bootstrap.config_model.Config.set('bootstrap_completed', False)
+ def test_is_bootstrap_completed_false_needs_update(self):
+ config_model.Config.set('running_version', '0.0.1-alpha')
self.assertFalse(bootstrap.is_bootstrap_completed())
- bootstrap.config_model.Config.set('bootstrap_completed', True)
- self.assertTrue(bootstrap.is_bootstrap_completed())
-
- def test_is_bootstrap_started(self):
+ def test_is_bootstrap_started_and_completed(self):
+ config_model.Config.set('bootstrap_completed', True)
+ config_model.Config.set('bootstrap_started', True)
+ # bootstrap_started is false (not in progress) if bootstrap completed.
self.assertFalse(bootstrap.is_bootstrap_started())
- bootstrap.config_model.Config.set('bootstrap_started', True)
- self.assertTrue(bootstrap.is_bootstrap_started())
-
- @mock.patch('__main__.bootstrap.constants.BOOTSTRAP_ENABLED', True)
- @mock.patch('__main__.bootstrap.get_all_bootstrap_functions')
- def test_get_bootstrap_task_status(self, mock_getall):
+ def test_is_new_deployment_false(self):
+ config_model.Config.set('running_version', constants.APP_VERSION)
+ self.assertFalse(bootstrap._is_new_deployment())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=True)
+ @mock.patch.object(bootstrap, 'is_update', autospec=True)
+ def test_get_bootstrap_functions_new_deployment(
+ self, mock_is_update, mock_is_new_deployment):
+ # Ensure that all initial deployment tasks are included.
+ self.assertTrue(
+ all(task in bootstrap.get_bootstrap_functions()
+ for task in bootstrap._BOOTSTRAP_INIT_TASKS))
+ self.assertEqual(mock_is_update.call_count, 0)
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=False)
+ def test_get_bootstrap_functions_update(self, mock_is_new_deployment):
+ # Ensure that all initial deployment tasks are not included.
+ self.assertFalse(
+ any(task in bootstrap._BOOTSTRAP_INIT_TASKS
+ for task in bootstrap.get_bootstrap_functions()))
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=False)
+ def test_get_bootstrap_functions_get_all(self, mock_is_new_deployment):
+ self.assertLen(
+ bootstrap.get_bootstrap_functions(get_all=True),
+ len(bootstrap._TASK_DESCRIPTIONS))
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=False)
+ def test_get_bootstrap_functions_failed(self, mock_is_new_deployment):
+ config_model.Config.set('running_version', constants.APP_VERSION)
+ # Initialize all task statuses to successful.
+ for task_name in bootstrap._TASK_DESCRIPTIONS.keys():
+ task_entity = bootstrap_status_model.BootstrapStatus.get_or_insert(
+ task_name)
+ task_entity.success = True
+ task_entity.put()
+ # Mock 1 task failure.
+ task_entity = bootstrap_status_model.BootstrapStatus.get_by_id(
+ 'bootstrap_datastore_yaml')
+ task_entity.success = False
+ task_entity.put()
+ # Ensure that only failed and all update tasks are included.
+ functions = bootstrap.get_bootstrap_functions()
+ self.assertCountEqual(
+ list(bootstrap._BOOTSTRAP_UPDATE_TASKS) + ['bootstrap_datastore_yaml'],
+ functions.keys())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=False)
+ @mock.patch.object(bootstrap, 'get_bootstrap_functions', autospec=True)
+ def test_get_bootstrap_task_status(
+ self, mock_get_bootstrap_functions, mock_is_new_deployment):
"""Tests get_bootstrap_task_status."""
+ config_model.Config.set('bootstrap_started', True)
yesterday = datetime.datetime.utcnow() - datetime.timedelta(days=-1)
def fake_function1():
@@ -197,7 +258,7 @@ def fake_function1():
def fake_function2():
pass
- mock_getall.return_value = {
+ mock_get_bootstrap_functions.return_value = {
'fake_function1': fake_function1,
'fake_function2': fake_function2
}
@@ -211,13 +272,65 @@ def fake_function2():
fake_entity2 = bootstrap_status_model.BootstrapStatus.get_or_insert(
'fake_function2')
- fake_entity2.success = False
+ fake_entity2.success = True
fake_entity2.timestamp = yesterday
- fake_entity2.details = 'Exception raise we failed oh no.'
+ fake_entity2.details = ''
fake_entity2.put()
status = bootstrap.get_bootstrap_task_status()
- self.assertEqual(len(status), 2)
+ self.assertLen(status, 2)
+ self.assertTrue(bootstrap.is_bootstrap_completed())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=False)
+ def test_is_latest_version_true(self, mock_is_new_deployment):
+ config_model.Config.set('running_version', constants.APP_VERSION)
+ self.assertTrue(bootstrap._is_latest_version())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', return_value=True)
+ def test_is_latest_version_false_new_deployment(self, mock_is_new_deployment):
+ config_model.Config.set('running_version', constants.APP_VERSION)
+ self.assertFalse(bootstrap._is_latest_version())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', autospec=True)
+ def test_is_latest_version_false_update(self, mock_is_new_deployment):
+ # Mock the state of an application requiring an update.
+ mock_is_new_deployment.return_value = False
+ config_model.Config.set('bootstrap_completed', True)
+ config_model.Config.set('running_version', '0.0.1-alpha')
+ for task in bootstrap._TASK_DESCRIPTIONS.keys():
+ fake_entity2 = bootstrap_status_model.BootstrapStatus.get_or_insert(task)
+ fake_entity2.success = True
+ fake_entity2.put()
+
+ self.assertFalse(bootstrap._is_latest_version())
+ # If we are not at the latest version, bootstrap should be incomplete.
+ self.assertFalse(config_model.Config.get('bootstrap_completed'))
+ # Update tasks should be marked as not completed when there is an update.
+ for task in bootstrap._BOOTSTRAP_UPDATE_TASKS:
+ status_entity = bootstrap_status_model.BootstrapStatus.get_by_id(task)
+ self.assertFalse(status_entity.success)
+ # All init task statuses should still be true in the case of an update.
+ for task in bootstrap._BOOTSTRAP_INIT_TASKS:
+ status_entity = bootstrap_status_model.BootstrapStatus.get_by_id(task)
+ self.assertTrue(status_entity.success)
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', autospec=True)
+ def test_is_update_new(self, mock_is_new_deployment):
+ mock_is_new_deployment.return_value = True
+ config_model.Config.set('running_version', '0.0')
+ self.assertFalse(bootstrap.is_update())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', autospec=True)
+ def test_is_update_up_to_date(self, mock_is_new_deployment):
+ config_model.Config.set('running_version', bootstrap.constants.APP_VERSION)
+ self.assertFalse(bootstrap.is_update())
+
+ @mock.patch.object(bootstrap, '_is_new_deployment', autospec=True)
+ def test_is_update_needs_update(self, mock_is_new_deployment):
+ # Mock the state of an application requiring an update.
+ mock_is_new_deployment.return_value = False
+ config_model.Config.set('running_version', '0.0.1-alpha')
+ self.assertTrue(bootstrap.is_update())
if __name__ == '__main__':
diff --git a/loaner/web_app/backend/lib/datastore_yaml.py b/loaner/web_app/backend/lib/datastore_yaml.py
index 69cdbd00..2fa1adc9 100644
--- a/loaner/web_app/backend/lib/datastore_yaml.py
+++ b/loaner/web_app/backend/lib/datastore_yaml.py
@@ -25,7 +25,6 @@
import yaml
from google.appengine.ext import ndb
-from loaner.web_app import constants
from loaner.web_app.backend.models import device_model
from loaner.web_app.backend.models import event_models
from loaner.web_app.backend.models import shelf_model
@@ -40,57 +39,42 @@ class Error(Exception):
"""Base class for exceptions in this module."""
-class DatastoreWipeError(Error):
- """Exception raised when DS wipe requested but BOOTSTRAP_ENABLED is False."""
-
-
def import_yaml(yaml_data, user_email, wipe=False, randomize_shelving=False):
"""Imports YAML data and creates app datastore entities.
- This allows wiping of the entire datastore, so for safety this option is
- disallowed if the constants module's BOOTSTRAP_ENABLED option is False.
+ This function optionally wipes and populates datastore with default values.
Args:
yaml_data: str, the YAML data containing device, shelf, core_event,
custom_event, and user data.
user_email: str, email address of the user making the request.
- wipe: bool, whether to delete the existing datastore contents. Ignored if
- constants.BOOTSTRAP_ENABLED is False.
+ wipe: bool, whether to delete the existing datastore contents.
randomize_shelving: bool, whether to assign Devices to Shelves randomly,
which may be useful in app testing.
-
- Raises:
- DatastoreWipeError: if a datastore wipe is requested but BOOTSTRAP_ENABLED
- is False.
"""
- yaml_data = yaml.load(yaml_data)
+ yaml_data = yaml.safe_load(yaml_data)
if wipe:
- if not constants.BOOTSTRAP_ENABLED:
- raise DatastoreWipeError(
- 'Requested datastore wipe disallowed. Change '
- 'constants.BOOTSTRAP_ENABLED to True to permit wiping.')
- else:
- logging.info(
- 'Wiping existing datastore entities for kinds found in YAML.')
- if yaml_data.get('core_events'):
- ndb.delete_multi(event_models.CoreEvent.query().fetch(keys_only=True))
- if yaml_data.get('custom_events'):
- ndb.delete_multi(event_models.CustomEvent.query().fetch(keys_only=True))
- if yaml_data.get('devices'):
- ndb.delete_multi(device_model.Device.query().fetch(keys_only=True))
- if yaml_data.get('reminder_events'):
- ndb.delete_multi(
- event_models.ReminderEvent.query().fetch(keys_only=True))
- if yaml_data.get('shelves'):
- ndb.delete_multi(shelf_model.Shelf.query().fetch(keys_only=True))
- if yaml_data.get('survey_questions'):
- ndb.delete_multi(
- survey_models.Question.query().fetch(keys_only=True))
- if yaml_data.get('templates'):
- ndb.delete_multi(template_model.Template.query().fetch(keys_only=True))
- if yaml_data.get('users'):
- ndb.delete_multi(user_model.User.query().fetch(keys_only=True))
+ logging.info(
+ 'Wiping existing datastore entities for kinds found in YAML.')
+ if yaml_data.get('core_events'):
+ ndb.delete_multi(event_models.CoreEvent.query().fetch(keys_only=True))
+ if yaml_data.get('custom_events'):
+ ndb.delete_multi(event_models.CustomEvent.query().fetch(keys_only=True))
+ if yaml_data.get('devices'):
+ ndb.delete_multi(device_model.Device.query().fetch(keys_only=True))
+ if yaml_data.get('reminder_events'):
+ ndb.delete_multi(
+ event_models.ReminderEvent.query().fetch(keys_only=True))
+ if yaml_data.get('shelves'):
+ ndb.delete_multi(shelf_model.Shelf.query().fetch(keys_only=True))
+ if yaml_data.get('survey_questions'):
+ ndb.delete_multi(
+ survey_models.Question.query().fetch(keys_only=True))
+ if yaml_data.get('templates'):
+ ndb.delete_multi(template_model.Template.query().fetch(keys_only=True))
+ if yaml_data.get('users'):
+ ndb.delete_multi(user_model.User.query().fetch(keys_only=True))
shelf_keys = []
diff --git a/loaner/web_app/backend/lib/datastore_yaml_test.py b/loaner/web_app/backend/lib/datastore_yaml_test.py
index e5047cf7..e30ba11e 100644
--- a/loaner/web_app/backend/lib/datastore_yaml_test.py
+++ b/loaner/web_app/backend/lib/datastore_yaml_test.py
@@ -136,15 +136,15 @@ def test_yaml_import(self, mock_directoryclass):
loanertest.TEST_DIR_DEVICE_DEFAULT, loanertest.TEST_DIR_DEVICE2
]
datastore_yaml.import_yaml(ALL_YAML, loanertest.USER_EMAIL)
- self.assertEqual(len(shelf_model.Shelf.query().fetch()), 2)
- self.assertEqual(len(device_model.Device.query().fetch()), 2)
- self.assertEqual(len(event_models.CoreEvent.query().fetch()), 1)
- self.assertEqual(len(event_models.ShelfAuditEvent.query().fetch()), 1)
- self.assertEqual(len(event_models.CustomEvent.query().fetch()), 1)
- self.assertEqual(len(event_models.ReminderEvent.query().fetch()), 1)
- self.assertEqual(len(survey_models.Question.query().fetch()), 1)
- self.assertEqual(len(template_model.Template.query().fetch()), 1)
- self.assertEqual(len(user_model.User.query().fetch()), 2)
+ self.assertLen(shelf_model.Shelf.query().fetch(), 2)
+ self.assertLen(device_model.Device.query().fetch(), 2)
+ self.assertLen(event_models.CoreEvent.query().fetch(), 1)
+ self.assertLen(event_models.ShelfAuditEvent.query().fetch(), 1)
+ self.assertLen(event_models.CustomEvent.query().fetch(), 1)
+ self.assertLen(event_models.ReminderEvent.query().fetch(), 1)
+ self.assertLen(survey_models.Question.query().fetch(), 1)
+ self.assertLen(template_model.Template.query().fetch(), 1)
+ self.assertLen(user_model.User.query().fetch(), 2)
@mock.patch('__main__.directory.DirectoryApiClient', autospec=True)
def test_yaml_import_with_randomized_shelves(self, mock_directoryclass):
@@ -161,13 +161,12 @@ def test_yaml_import_with_randomized_shelves(self, mock_directoryclass):
randomize_shelving=True)
devices = device_model.Device.query().fetch()
shelves = shelf_model.Shelf.query().fetch()
- self.assertEqual(len(devices), 2)
- self.assertEqual(len(shelves), 2)
+ self.assertLen(devices, 2)
+ self.assertLen(shelves, 2)
for device in devices:
- self.assertTrue(device.shelf in [shelf.key for shelf in shelves])
+ self.assertIn(device.shelf, [shelf.key for shelf in shelves])
@mock.patch('__main__.directory.DirectoryApiClient', autospec=True)
- @mock.patch('__main__.constants.BOOTSTRAP_ENABLED', True)
def test_yaml_import_with_wipe(self, mock_directoryclass):
"""Tests YAML importing with a datastore wipe."""
mock_directoryclient = mock_directoryclass.return_value
@@ -183,11 +182,15 @@ def test_yaml_import_with_wipe(self, mock_directoryclass):
capacity=42,
friendly_name='Nice shelf',
responsible_for_audit='inventory')
+ user_model.User(id=loanertest.USER_EMAIL).put()
+ template_model.Template.create('template_1')
+ template_model.Template.create('template_2')
test_event = event_models.CoreEvent.create('test_event')
test_event.description = 'A test event'
test_event.enabled = True
test_event.actions = ['some_action', 'another_action']
test_event.put()
+ event_models.CustomEvent.create('test_custom_event')
datastore_yaml.import_yaml(ALL_YAML, loanertest.USER_EMAIL, wipe=True)
@@ -202,34 +205,22 @@ def test_yaml_import_with_wipe(self, mock_directoryclass):
templates = template_model.Template.query().fetch()
users = user_model.User.query().fetch()
- self.assertEqual(len(shelves), 2)
- self.assertEqual(len(devices), 2)
- self.assertEqual(len(core_events), 1)
- self.assertEqual(len(shelf_audit_events), 1)
- self.assertEqual(len(custom_events), 1)
- self.assertEqual(len(reminder_events), 1)
- self.assertEqual(len(survey_questions), 1)
- self.assertEqual(len(templates), 1)
- self.assertEqual(len(users), 2)
-
- self.assertTrue(test_device.serial_number not in
- [device.serial_number for device in devices])
- self.assertTrue(
- test_shelf.location not in [shelf.location for shelf in shelves])
- self.assertTrue(
- test_event.name not in [event.name for event in core_events])
- self.assertTrue(isinstance(
- custom_events[0].conditions[0].value, datetime.timedelta))
-
- @mock.patch('__main__.constants.BOOTSTRAP_ENABLED', False)
- def test_datastore_wipe_without_enablement(self):
- """Tests that an exception is raised when datastore can't be wiped."""
- self.assertRaises(
- datastore_yaml.DatastoreWipeError,
- datastore_yaml.import_yaml,
- ALL_YAML,
- loanertest.USER_EMAIL,
- wipe=True)
+ self.assertLen(shelves, 2)
+ self.assertLen(devices, 2)
+ self.assertLen(core_events, 1)
+ self.assertLen(shelf_audit_events, 1)
+ self.assertLen(custom_events, 1)
+ self.assertLen(reminder_events, 1)
+ self.assertLen(survey_questions, 1)
+ self.assertLen(templates, 1)
+ self.assertLen(users, 2)
+
+ self.assertNotIn(test_device.serial_number,
+ [device.serial_number for device in devices])
+ self.assertNotIn(test_shelf.location, [shelf.location for shelf in shelves])
+ self.assertNotIn(test_event.name, [event.name for event in core_events])
+ self.assertIsInstance(custom_events[0].conditions[0].value,
+ datetime.timedelta)
if __name__ == '__main__':
diff --git a/loaner/web_app/backend/lib/search_utils.py b/loaner/web_app/backend/lib/search_utils.py
index 80c0b4be..f3bdea37 100644
--- a/loaner/web_app/backend/lib/search_utils.py
+++ b/loaner/web_app/backend/lib/search_utils.py
@@ -19,12 +19,13 @@
from __future__ import print_function
import logging
-import math
from protorpc import messages
from google.appengine.api import search
+import endpoints
+
from loaner.web_app.backend.api.messages import shared_messages
from loaner.web_app.backend.models import device_model
@@ -88,31 +89,26 @@ def document_to_message(document, message):
return message
-def calculate_page_offset(page_size, page_number):
- """Calculates the page offset for a given page size and number.
+def get_search_cursor(web_safe_string):
+ """Converts the web_safe_string from search results into a cursor.
Args:
- page_size: int, the size of the amount of items for a page.
- page_number: int, the page number to calculate an offset for.
+ web_safe_string: str, the web_safe_string from a search query cursor.
Returns:
- The calculated integer value for the offset.
- """
- return (page_number - 1) * page_size
-
+ A tuple consisting of a search.Cursor or None and a boolean for whether or
+ not more results exist.
-def calculate_total_pages(page_size, total_results):
- """Calculates the number of pages for a given page size and number of results.
-
- Args:
- page_size: int, the size of the amount of items for a page.
- total_results: int, the number of results.
-
- Returns:
- The calculated integer value of the total number of pages.
+ Raises:
+ endpoints.BadRequestException: if the creation of the search.Cursor fails.
"""
- total_pages = total_results/page_size
- return int(math.ceil(total_pages))
+ try:
+ cursor = search.Cursor(
+ web_safe_string=web_safe_string)
+ except ValueError:
+ raise endpoints.BadRequestException(_CORRUPT_KEY_MSG)
+
+ return cursor
def set_search_query_options(request):
@@ -145,7 +141,7 @@ def set_search_query_options(request):
if expressions:
sort_options = search.SortOptions(expressions=expressions)
except AttributeError:
- # We do not want to so anything if the message does not have expressions
+ # We do not want to do anything if the message does not have expressions
# since sort_options is already set to None above.
pass
diff --git a/loaner/web_app/backend/lib/search_utils_test.py b/loaner/web_app/backend/lib/search_utils_test.py
index 17a6e090..8d108c8a 100644
--- a/loaner/web_app/backend/lib/search_utils_test.py
+++ b/loaner/web_app/backend/lib/search_utils_test.py
@@ -24,6 +24,8 @@
from google.appengine.api import search
+import endpoints
+
from loaner.web_app.backend.api.messages import device_messages
from loaner.web_app.backend.api.messages import shared_messages
from loaner.web_app.backend.api.messages import shelf_messages
@@ -86,19 +88,22 @@ def test_document_to_message(
self.assertEqual(response_message, expected_message)
self.assertEqual(mock_logging.error.call_count, log_call_count)
- def test_calculate_page_offset(self):
- """Tests the calculation of page offset."""
- page_size = 10
- page_number = 5
- offset = search_utils.calculate_page_offset(page_size, page_number)
- self.assertEqual(40, offset)
-
- def test_calculate_total_pages(self):
- """Tests the calculation of total pages."""
- page_size = 6
- total_results = 11
- total_pages = search_utils.calculate_total_pages(page_size, total_results)
- self.assertEqual(2, total_pages)
+ def test_get_search_cursor(self):
+ """Tests the creation of a search cursor with a web_safe_string."""
+ expected_cursor_web_safe_string = 'False:ODUxODBhNTgyYTQ2ZmI0MDU'
+ returned_cursor = (
+ search_utils.get_search_cursor(
+ expected_cursor_web_safe_string))
+ self.assertEqual(
+ expected_cursor_web_safe_string, returned_cursor.web_safe_string)
+
+ @mock.patch.object(search, 'Cursor', autospec=True)
+ def test_get_search_cursor_error(self, mock_cursor):
+ """Tests the creation of a search cursor when an error occurs."""
+ mock_cursor.side_effect = ValueError
+ with self.assertRaisesWithLiteralMatch(
+ endpoints.BadRequestException, search_utils._CORRUPT_KEY_MSG):
+ search_utils.get_search_cursor(None)
@parameterized.named_parameters(
{'testcase_name': 'QueryStringOnly',
diff --git a/loaner/web_app/backend/lib/send_email.py b/loaner/web_app/backend/lib/send_email.py
index c288d89c..599b3229 100644
--- a/loaner/web_app/backend/lib/send_email.py
+++ b/loaner/web_app/backend/lib/send_email.py
@@ -23,7 +23,7 @@
import html2text
-from google.appengine.api import mail
+from google.appengine.api import taskqueue
from loaner.web_app import constants
from loaner.web_app.backend.models import config_model
@@ -124,9 +124,5 @@ def _send_email(**kwargs):
kwargs['subject'] = '[local] ' + kwargs['subject']
elif constants.ON_QA:
kwargs['subject'] = '[qa] ' + kwargs['subject']
- try:
- mail.send_mail(**kwargs)
- except mail.InvalidEmailError as error:
- logging.error(
- 'Email helper failed to send mail due to an error: %s. (Kwargs: %s)',
- error.message, kwargs)
+
+ taskqueue.add(queue_name='send-email', params=kwargs, target='default')
diff --git a/loaner/web_app/backend/lib/send_email_test.py b/loaner/web_app/backend/lib/send_email_test.py
index b67b92a2..42807748 100644
--- a/loaner/web_app/backend/lib/send_email_test.py
+++ b/loaner/web_app/backend/lib/send_email_test.py
@@ -19,12 +19,11 @@
from __future__ import print_function
import datetime
-import logging
from absl.testing import parameterized
import mock
-from google.appengine.api import mail
+from google.appengine.api import taskqueue
from loaner.web_app import constants
from loaner.web_app.backend.lib import send_email
@@ -62,18 +61,12 @@ def test_send_email(
constants.ON_QA = on_qa
constants.ON_DEV = on_dev
constants.ON_LOCAL = on_local
- with mock.patch.object(mail, 'send_mail') as mock_gae_sendmail:
+ with mock.patch.object(taskqueue, 'add') as mock_taskqueue_add:
send_email._send_email(**self.default_kwargs)
self.default_kwargs['subject'] = (
instance_subject + self.default_kwargs['subject'])
- mock_gae_sendmail.assert_called_once_with(**self.default_kwargs)
-
- @mock.patch.object(mail, 'send_mail', side_effect=mail.InvalidEmailError)
- @mock.patch.object(logging, 'error')
- def test_send_email_error(self, mock_logerror, mock_gae_sendmail):
- send_email.constants.ON_PROD = True
- send_email._send_email(**self.default_kwargs)
- assert mock_logerror.called
+ mock_taskqueue_add.assert_called_once_with(
+ queue_name='send-email', params=self.default_kwargs, target='default')
@mock.patch('__main__.send_email.logging')
@mock.patch('__main__.send_email._send_email')
diff --git a/loaner/web_app/backend/lib/utils.py b/loaner/web_app/backend/lib/utils.py
index b2fd2dcd..d7aa689a 100644
--- a/loaner/web_app/backend/lib/utils.py
+++ b/loaner/web_app/backend/lib/utils.py
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Utility methods to perform actions in consitent ways across the app."""
+"""Utility methods to perform actions in consistent ways across the app."""
from __future__ import absolute_import
from __future__ import division
diff --git a/loaner/web_app/backend/lib/utils_py23_migration_test.py b/loaner/web_app/backend/lib/utils_py23_migration_test.py
new file mode 100644
index 00000000..18a93dc6
--- /dev/null
+++ b/loaner/web_app/backend/lib/utils_py23_migration_test.py
@@ -0,0 +1,57 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.lib.utils_py23_migration."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import datetime
+from loaner.web_app.backend.lib import utils
+from absl.testing import absltest
+
+
+class UtilsPy23MigrationTest(absltest.TestCase):
+
+ def testConvertDatetimeToUnix(self):
+ timestamp = datetime.datetime(2016, 8, 1, 1, 1)
+ unix_timestamp = utils.datetime_to_unix(timestamp)
+ self.assertEqual(unix_timestamp, 1470013260)
+
+ def testConvertDatetimeToUnix_milliseconds(self):
+ timestamp = datetime.datetime(2016, 8, 1, 1, 1)
+ unix_timestamp = utils.datetime_to_unix(timestamp, True)
+ self.assertEqual(unix_timestamp, 1470013260000)
+
+ def testIsWeekendOrMonday(self):
+ date = datetime.datetime(2017, 10, 21)
+ self.assertTrue(utils.is_weekend_or_monday(date))
+
+ date = datetime.datetime(2017, 10, 22)
+ self.assertTrue(utils.is_weekend_or_monday(date))
+
+ date = datetime.datetime(2017, 10, 23)
+ self.assertTrue(utils.is_weekend_or_monday(date))
+
+ date = datetime.datetime(2017, 10, 20)
+ self.assertFalse(utils.is_weekend_or_monday(date))
+
+ date = datetime.datetime(2017, 10, 18)
+ self.assertFalse(utils.is_weekend_or_monday(date))
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/models/BUILD b/loaner/web_app/backend/models/BUILD
index b1fac2a5..93e13480 100644
--- a/loaner/web_app/backend/models/BUILD
+++ b/loaner/web_app/backend/models/BUILD
@@ -1,18 +1,18 @@
# Description:
# BUILD file for //loaner/web_app/backend/models.
-package(
- default_visibility = [
- "//loaner:__subpackages__",
- ],
-)
-
load(
"//loaner:builddefs.bzl",
"loaner_appengine_library",
"loaner_appengine_test",
)
+package(
+ default_visibility = [
+ "//loaner:__subpackages__",
+ ],
+)
+
# ==============================================================================
# Libraries
# ==============================================================================
@@ -26,6 +26,7 @@ loaner_appengine_library(
":config_model",
":device_model",
":event_models",
+ ":fleet_model",
":shelf_model",
":survey_models",
":tag_model",
@@ -41,6 +42,7 @@ loaner_appengine_library(
],
deps = [
"//loaner/web_app/backend/lib:utils",
+ "@six_archive//:six",
],
)
@@ -64,13 +66,15 @@ loaner_appengine_library(
],
)
-loaner_appengine_library(
+py_library(
name = "config_model",
srcs = [
"config_model.py",
],
+ srcs_version = "PY2AND3",
deps = [
"//loaner/web_app/backend/lib:utils",
+ "@six_archive//:six",
],
)
@@ -82,10 +86,12 @@ loaner_appengine_library(
deps = [
":base_model",
":config_model",
+ ":tag_model",
":user_model",
"//loaner/web_app:constants",
"//loaner/web_app/backend/api:permissions",
"//loaner/web_app/backend/clients:directory",
+ "//loaner/web_app/backend/lib:api_utils",
"//loaner/web_app/backend/lib:events",
"//loaner/web_app/backend/lib:user",
"@absl_archive//absl/logging",
@@ -102,6 +108,17 @@ loaner_appengine_library(
],
)
+loaner_appengine_library(
+ name = "fleet_model",
+ srcs = [
+ "fleet_model.py",
+ ],
+ deps = [
+ ":base_model",
+ "//loaner/web_app/backend/lib:utils",
+ ],
+)
+
loaner_appengine_library(
name = "shelf_model",
srcs = [
@@ -135,7 +152,6 @@ loaner_appengine_library(
],
deps = [
":base_model",
- "//loaner/web_app/backend/lib:api_utils",
],
)
@@ -210,9 +226,11 @@ loaner_appengine_test(
],
deps = [
":config_model",
+ ":fleet_model",
"//loaner/web_app/backend/testing:loanertest",
"@absl_archive//absl/testing:absltest",
"@absl_archive//absl/testing:parameterized",
+ "@mock_archive//:mock",
"@pyfakefs_archive//:pyfakefs",
],
)
@@ -226,6 +244,7 @@ loaner_appengine_test(
":config_model",
":device_model",
":shelf_model",
+ ":tag_model",
":user_model",
"//loaner/web_app:constants",
"//loaner/web_app/backend/clients:directory",
@@ -252,6 +271,17 @@ loaner_appengine_test(
],
)
+loaner_appengine_test(
+ name = "fleet_model_test",
+ srcs = [
+ "fleet_model_test.py",
+ ],
+ deps = [
+ ":fleet_model",
+ "//loaner/web_app/backend/testing:loanertest",
+ ],
+)
+
loaner_appengine_test(
name = "shelf_model_test",
srcs = [
@@ -302,6 +332,7 @@ loaner_appengine_test(
deps = [
":template_model",
"//loaner/web_app/backend/testing:loanertest",
+ "@absl_archive//absl/testing:parameterized",
"@mock_archive//:mock",
],
)
@@ -327,6 +358,7 @@ test_suite(
":config_model_test",
":device_model_test",
":event_models_test",
+ ":fleet_model_test",
":shelf_model_test",
":survey_models_test",
":tag_model_test",
diff --git a/loaner/web_app/backend/models/base_model.py b/loaner/web_app/backend/models/base_model.py
index fd0704b4..5761b4e0 100644
--- a/loaner/web_app/backend/models/base_model.py
+++ b/loaner/web_app/backend/models/base_model.py
@@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Lint as: python2, python3
"""Base model class for the loaner project."""
from __future__ import absolute_import
@@ -26,12 +27,12 @@
import string
from protorpc import messages
+import six
from google.appengine.api import search
from google.appengine.api import taskqueue
from google.appengine.ext import ndb
from google.appengine.runtime import apiproxy_errors
-
from loaner.web_app.backend.lib import utils
_PUT_DOC_ERR_MSG = 'Error putting a document (%s) into the index (%s).'
@@ -208,8 +209,9 @@ def _to_search_fields(self, key, value):
name=key, value=search.GeoPoint(value.lat, value.lon))]
return [
- search.TextField(name=key, value=unicode(value)),
- search.AtomField(name=key, value=unicode(value))]
+ search.TextField(name=key, value=six.text_type(value)),
+ search.AtomField(name=key, value=six.text_type(value))
+ ]
def _get_document_fields(self):
"""Enumerates search document fields from entity properties.
@@ -244,7 +246,7 @@ def to_document(self):
"""
try:
return search.Document(
- doc_id=str(self.key.urlsafe()),
+ doc_id=six.ensure_str(self.key.urlsafe()),
fields=self._get_document_fields())
except (TypeError, ValueError) as e:
@@ -252,15 +254,15 @@ def to_document(self):
@classmethod
def search(
- cls, query_string='', query_limit=20, offset=0, sort_options=None,
+ cls, query_string='', query_limit=20, cursor=None, sort_options=None,
returned_fields=None):
"""Searches for documents that match a given query string.
Args:
query_string: str, the query to match against documents in the index
query_limit: int, the limit on number of documents to return in results.
- offset: int, the number of matched documents to skip before beginning to
- return results.
+ cursor: search.Cursor, a cursor describing where to get the next set of
+ results, or to provide next cursors in SearchResults.
sort_options: search.SortOptions, an object specifying a multi-dimensional
sort over search results.
returned_fields: List[str], an iterable of names of fields to return in
@@ -276,7 +278,7 @@ def search(
query = search.Query(
query_string=cls.format_query(query_string),
options=search.QueryOptions(
- offset=offset, limit=query_limit, sort_options=sort_options,
+ cursor=cursor, limit=query_limit, sort_options=sort_options,
returned_fields=returned_fields),
)
except search.QueryError:
@@ -315,7 +317,7 @@ def format_query(cls, query_string):
def _sanitize_dict(entity_dict):
"""Sanitizes select values of an entity-derived dictionary."""
- for key, value in entity_dict.iteritems():
+ for key, value in six.iteritems(entity_dict):
if isinstance(value, dict):
entity_dict[key] = _sanitize_dict(value)
elif isinstance(value, list):
diff --git a/loaner/web_app/backend/models/base_model_test.py b/loaner/web_app/backend/models/base_model_test.py
index 4ee84931..76038b3a 100644
--- a/loaner/web_app/backend/models/base_model_test.py
+++ b/loaner/web_app/backend/models/base_model_test.py
@@ -22,6 +22,7 @@
from absl.testing import parameterized
import mock
+import six
from google.appengine.api import search
from google.appengine.ext import ndb
@@ -280,7 +281,7 @@ def test_to_document(self, mock_get_document_fields):
fields = [search.AtomField(name='text_field', value='12345ABC')]
mock_get_document_fields.return_value = fields
test_document = search.Document(
- doc_id=test_model.key.urlsafe(), fields=fields)
+ doc_id=six.ensure_str(test_model.key.urlsafe()), fields=fields)
result = test_model.to_document()
self.assertEqual(result, test_document)
diff --git a/loaner/web_app/backend/models/bigquery_row_model.py b/loaner/web_app/backend/models/bigquery_row_model.py
index d4ed6c4a..d9d1a105 100644
--- a/loaner/web_app/backend/models/bigquery_row_model.py
+++ b/loaner/web_app/backend/models/bigquery_row_model.py
@@ -93,7 +93,10 @@ def _time_threshold_reached(cls):
"""Checks if the time threshold for a BigQuery stream was met."""
threshold = datetime.datetime.utcnow() - datetime.timedelta(
minutes=constants.BIGQUERY_ROW_TIME_THRESHOLD)
- return cls._get_last_unstreamed_row().timestamp <= threshold
+ last_unstreamed_row = cls._get_last_unstreamed_row()
+ if last_unstreamed_row:
+ return last_unstreamed_row.timestamp <= threshold
+ return False
@classmethod
def _row_threshold_reached(cls):
@@ -124,6 +127,13 @@ def stream_rows(cls):
logging.error('Unable to stream rows.')
return
_set_streamed(rows)
+ for row in rows:
+ row.delete()
+
+ def delete(self):
+ """Deletes streamed row from datastore."""
+ if self.streamed:
+ self.key.delete()
def _set_streamed(rows):
diff --git a/loaner/web_app/backend/models/bigquery_row_model_test.py b/loaner/web_app/backend/models/bigquery_row_model_test.py
index e8c8ba1b..baf1a047 100644
--- a/loaner/web_app/backend/models/bigquery_row_model_test.py
+++ b/loaner/web_app/backend/models/bigquery_row_model_test.py
@@ -87,6 +87,14 @@ def test_time_threshold_reached(self):
self.test_row_1.put()
self.assertTrue(bigquery_row_model.BigQueryRow._time_threshold_reached())
+ @freezegun.freeze_time('1956-01-31')
+ def test_time_threshold_reached_fail_no_unstreamed_rows(self):
+ self.test_row_1.streamed = True
+ self.test_row_1.put()
+ self.test_row_2.streamed = True
+ self.test_row_2.put()
+ self.assertFalse(bigquery_row_model.BigQueryRow._time_threshold_reached())
+
@freezegun.freeze_time('1956-01-31')
def test_time_threshold_reached_fail(self):
threshold = datetime.datetime.utcnow() - datetime.timedelta(
@@ -115,7 +123,8 @@ def test_row_threshold_reached_fail(self):
('time', '_time_threshold_reached'),
('rows', '_row_threshold_reached'))
@mock.patch.object(ndb, 'put_multi', autospec=True)
- def test_stream_rows(self, threshold_function, mock_put_multi):
+ @mock.patch.object(bigquery_row_model.BigQueryRow, 'delete')
+ def test_stream_rows(self, threshold_function, mock_delete, mock_put_multi):
test_row_dict_1 = self.test_row_1.to_json_dict()
test_row_dict_2 = self.test_row_2.to_json_dict()
test_row_1 = (test_row_dict_1['ndb_key'], test_row_dict_1['timestamp'],
@@ -142,6 +151,7 @@ def test_stream_rows(self, threshold_function, mock_put_multi):
self.assertTrue(self.test_row_1.streamed)
self.assertTrue(self.test_row_2.streamed)
self.assertEqual(mock_put_multi.call_count, 1)
+ self.assertEqual(mock_delete.call_count, 2)
def test_stream_rows_insert_error(self):
self.mock_bigquery_client.stream_table.side_effect = bigquery.InsertError
@@ -151,5 +161,19 @@ def test_stream_rows_insert_error(self):
with self.assertRaises(bigquery.InsertError):
bigquery_row_model.BigQueryRow.stream_rows()
+ def test_delete(self):
+ self.test_row_1.streamed = True
+
+ self.test_row_1.delete()
+
+ self.assertLen(bigquery_row_model.BigQueryRow._fetch_unstreamed_rows(), 1)
+
+ def test_deleted_fail(self):
+ self.test_row_1.streamed = False
+
+ self.test_row_1.delete()
+
+ self.assertLen(bigquery_row_model.BigQueryRow._fetch_unstreamed_rows(), 2)
+
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/models/bootstrap_status_model_py23_migration_test.py b/loaner/web_app/backend/models/bootstrap_status_model_py23_migration_test.py
new file mode 100644
index 00000000..9b050356
--- /dev/null
+++ b/loaner/web_app/backend/models/bootstrap_status_model_py23_migration_test.py
@@ -0,0 +1,46 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.models.bootstrap_status_model_py23_migration."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from datetime import datetime # pylint: disable=g-importing-member
+import mock
+from loaner.web_app.backend.models import bootstrap_status_model
+from absl.testing import absltest
+
+
+class BootstrapStatusModelPy23MigrationTest(absltest.TestCase):
+
+ def test_get_bootstrap_status(self):
+ mock_date = mock.Mock(return_value=datetime(2020, 3, 1))
+ bootstrap_object = bootstrap_status_model.BootstrapStatus(
+ description='test_description',
+ success=True,
+ timestamp=mock_date(),
+ details='test_details')
+ self.assertIsInstance(bootstrap_object,
+ bootstrap_status_model.BootstrapStatus)
+ self.assertEqual(True, bootstrap_object.success)
+ self.assertEqual('test_description', bootstrap_object.description)
+ self.assertEqual('test_details', bootstrap_object.details)
+ self.assertEqual(mock_date(), bootstrap_object.timestamp)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/models/config_model.py b/loaner/web_app/backend/models/config_model.py
index cac8093e..8df1a27f 100644
--- a/loaner/web_app/backend/models/config_model.py
+++ b/loaner/web_app/backend/models/config_model.py
@@ -17,6 +17,7 @@
from __future__ import division
from __future__ import print_function
+import six
from google.appengine.api import memcache
from google.appengine.ext import ndb
@@ -57,33 +58,35 @@ def get(cls, name):
Raises:
KeyError: An error occurred when name does not exist.
"""
- config_defaults = utils.load_config_from_yaml()
memcache_config = memcache.get(name)
cached_config = None
if memcache_config:
return memcache_config
- else:
- stored_config = cls.get_by_id(name, use_memcache=False)
- if stored_config:
- if stored_config.string_value:
- cached_config = stored_config.string_value
- elif stored_config.integer_value:
- cached_config = stored_config.integer_value
- elif stored_config.bool_value is not None:
- cached_config = stored_config.bool_value
- elif stored_config.list_value:
- cached_config = stored_config.list_value
- # Conversion from use_asset_tags to device_identifier_mode.
- if name == 'device_identifier_mode' and not cached_config:
- if cls.get('use_asset_tags'):
- cached_config = DeviceIdentifierMode.BOTH_REQUIRED
- cls.set(name, cached_config)
- memcache.set(name, cached_config)
- if cached_config is not None:
+
+ stored_config = cls.get_by_id(name, use_memcache=False)
+ if stored_config:
+ if stored_config.string_value:
+ cached_config = stored_config.string_value
+ elif stored_config.integer_value:
+ cached_config = stored_config.integer_value
+ elif stored_config.bool_value is not None:
+ cached_config = stored_config.bool_value
+ elif stored_config.list_value:
+ cached_config = stored_config.list_value
+ # Conversion from use_asset_tags to device_identifier_mode.
+ if name == 'device_identifier_mode' and not cached_config:
+ if cls.get('use_asset_tags'):
+ cached_config = DeviceIdentifierMode.BOTH_REQUIRED
+ cls.set(name, cached_config)
memcache.set(name, cached_config)
- return cached_config
- elif name in config_defaults:
- return config_defaults[name]
+ if cached_config is not None:
+ memcache.set(name, cached_config)
+ return cached_config
+ config_defaults = utils.load_config_from_yaml()
+ if name in config_defaults:
+ value = config_defaults[name]
+ cls.set(name, value)
+ return value
raise KeyError(_CONFIG_NOT_FOUND_MSG, name)
@@ -103,7 +106,7 @@ def set(cls, name, value, validate=True):
if name not in config_defaults:
raise KeyError(_CONFIG_NOT_FOUND_MSG % name)
- if isinstance(value, basestring):
+ if isinstance(value, six.string_types):
stored_config = cls.get_or_insert(name)
stored_config.string_value = value
stored_config.put()
diff --git a/loaner/web_app/backend/models/config_model_py23_migration_test.py b/loaner/web_app/backend/models/config_model_py23_migration_test.py
new file mode 100644
index 00000000..41424ecb
--- /dev/null
+++ b/loaner/web_app/backend/models/config_model_py23_migration_test.py
@@ -0,0 +1,164 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.models.config_model_py23_migration."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import mock
+from loaner.web_app.backend.models import config_model
+from absl.testing import absltest
+
+
+class ConfigModelPy23MigrationTest(absltest.TestCase):
+
+ def testConfigProperties(self):
+ self.assertEqual(True, config_model.Config.bool_value)
+ self.assertEqual('test', config_model.Config.string_value)
+ self.assertEqual(1, config_model.Config.integer_value)
+ self.assertEqual('test', config_model.Config.list_value)
+
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGetMemcacheConfig(self, mock_get):
+ mock_get.return_value = 'mock_memcache'
+ config_model.Config.get('test_name')
+ mock_get.assert_called_with('test_name')
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_by_id')
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGet(self, mock_get, mock_get_by_id, mock_set):
+ mock_get.return_value = ''
+ mock_get_by_id.return_value = mock.MagicMock(
+ string_value='test_string',
+ integer_value=10,
+ bool_value=True,
+ list_value=['test_list'])
+ mock_set.return_value = 'test_memcache'
+ config_model.Config.get('test_name')
+ mock_get.assert_called_with('test_name')
+ mock_get_by_id.assert_called_with('test_name', use_memcache=False)
+ mock_set.assert_called_with('test_name', 'test_string')
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_by_id')
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGetwithInt(self, mock_get, mock_get_by_id, mock_set):
+ mock_get.return_value = ''
+ mock_get_by_id.return_value = mock.MagicMock(
+ string_value='',
+ integer_value=10,
+ bool_value=True,
+ list_value=['test_list'])
+ mock_set.return_value = 'test_memcache'
+ config_model.Config.get('test_name')
+ mock_get.assert_called_with('test_name')
+ mock_get_by_id.assert_called_with('test_name', use_memcache=False)
+ mock_set.assert_called_with('test_name', 10)
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_by_id')
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGetwithBool(self, mock_get, mock_get_by_id, mock_set):
+ mock_get.return_value = ''
+ mock_get_by_id.return_value = mock.MagicMock(
+ string_value='',
+ integer_value=0,
+ bool_value=True,
+ list_value=['test_list'])
+ mock_set.return_value = 'test_memcache'
+ config_model.Config.get('test_name')
+ mock_get.assert_called_with('test_name')
+ mock_get_by_id.assert_called_with('test_name', use_memcache=False)
+ mock_set.assert_called_with('test_name', True)
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_by_id')
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGetwithList(self, mock_get, mock_get_by_id, mock_set):
+ mock_get.return_value = ''
+ mock_get_by_id.return_value = mock.MagicMock(
+ string_value='',
+ integer_value=0,
+ bool_value=None,
+ list_value=['test_list'])
+ mock_set.return_value = 'test_memcache'
+ config_model.Config.get('test_name')
+ mock_get.assert_called_with('test_name')
+ mock_get_by_id.assert_called_with('test_name', use_memcache=False)
+ mock_set.assert_called_with('test_name', ['test_list'])
+
+ @mock.patch.object(config_model.Config, 'set')
+ @mock.patch.object(config_model.utils, 'load_config_from_yaml')
+ @mock.patch.object(config_model.Config, 'get_by_id')
+ @mock.patch.object(config_model.memcache, 'get')
+ def testGetwithonly(self, mock_get, mock_get_by_id, mock_yaml,
+ mock_config_set):
+ mock_get.return_value = ''
+ mock_get_by_id.return_value = ''
+ mock_yaml.return_value = {'test_name': 'name'}
+ config_model.Config.get('test_name')
+ mock_config_set.assert_called_with('test_name', 'name')
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_or_insert')
+ @mock.patch.object(config_model.utils, 'load_config_from_yaml')
+ def testSetWithStringValue(self, mock_yaml, mock_get_insert, mock_set):
+ mock_yaml.return_value = {'test': 'test_value'}
+ stored_config_mock = mock.Mock()
+ stored_config_mock.string_value = 'test_value'
+ stored_config_mock.is_global = True
+ mock_get_insert.return_value = stored_config_mock
+
+ config_model.Config.set('test', 'test_value')
+ mock_set.assert_called_with('test', 'test_value')
+ mock_yaml.assert_called()
+ mock_get_insert.assert_called_with('test')
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_or_insert')
+ @mock.patch.object(config_model.utils, 'load_config_from_yaml')
+ def testSetWithIntValue(self, mock_yaml, mock_get_insert, mock_set):
+ mock_yaml.return_value = {'test': 'test_value'}
+ stored_config_mock = mock.Mock()
+ stored_config_mock.string_value = 'test_value'
+ stored_config_mock.is_global = True
+ mock_get_insert.return_value = stored_config_mock
+ config_model.Config.set('test', 1)
+ mock_set.assert_called_with('test', 1)
+ mock_yaml.assert_called()
+ mock_get_insert.assert_called_with('test')
+ config_model.Config.set('test', [1])
+
+ @mock.patch.object(config_model.memcache, 'set')
+ @mock.patch.object(config_model.Config, 'get_or_insert')
+ @mock.patch.object(config_model.utils, 'load_config_from_yaml')
+ def testSetWithListValue(self, mock_yaml, mock_get_insert, mock_set
+ ):
+ mock_yaml.return_value = {'test': 'test_value'}
+ stored_config_mock = mock.Mock()
+ stored_config_mock.string_value = 'test_value'
+ stored_config_mock.is_global = True
+ mock_get_insert.return_value = stored_config_mock
+ config_model.Config.set('test', [1])
+ mock_set.assert_called_with('test', [1])
+ mock_yaml.assert_called()
+ mock_get_insert.assert_called_with('test')
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/models/config_model_test.py b/loaner/web_app/backend/models/config_model_test.py
index 9d625f93..d44e399a 100644
--- a/loaner/web_app/backend/models/config_model_test.py
+++ b/loaner/web_app/backend/models/config_model_test.py
@@ -24,9 +24,11 @@
from absl.testing import parameterized
from pyfakefs import fake_filesystem
+import mock
from pyfakefs import mox3_stubout
from google.appengine.api import memcache
+from google.appengine.ext import ndb
from absl.testing import absltest
from loaner.web_app import constants
@@ -106,12 +108,16 @@ def test_get_from_memcache(self):
self.assertEqual(config_memcache, config_value)
self.assertEqual(reference_datastore_config.string_value, 'config value 1')
- def test_get_from_default(self):
+ @mock.patch.object(config_model.Config, 'set')
+ @mock.patch.object(memcache, 'get', return_value=None)
+ @mock.patch.object(ndb.Model, 'get_by_id', return_value=None)
+ def test_get_from_default(
+ self, mock_get_by_id, mock_memcache_get, mock_config_model_set):
config = 'test_config'
+ expected_value = 'test_value'
config_datastore = config_model.Config.get(config)
- self.assertEqual(config_datastore, 'test_value')
- self.assertIsNone(memcache.get(config))
- self.assertIsNone(config_model.Config.get_by_id(config))
+ mock_config_model_set.assert_called_once_with(config, expected_value)
+ self.assertEqual(config_datastore, expected_value)
def test_get_identifier_with_use_asset(self):
config_model.Config.set('use_asset_tags', True)
@@ -138,7 +144,7 @@ def test_set(self, test_config):
def test_set_nonexistent(self):
with self.assertRaisesRegexp(KeyError,
- config_model._CONFIG_NOT_FOUND_MSG % 'fake'):
+ config_model._CONFIG_NOT_FOUND_MSG % 'fake'):
config_model.Config.set('fake', 'does_not_exist')
def test_set_no_validation(self):
diff --git a/loaner/web_app/backend/models/device_model.py b/loaner/web_app/backend/models/device_model.py
index 8e104950..a2feada8 100644
--- a/loaner/web_app/backend/models/device_model.py
+++ b/loaner/web_app/backend/models/device_model.py
@@ -34,6 +34,7 @@
from loaner.web_app.backend.lib import user as user_lib
from loaner.web_app.backend.models import base_model
from loaner.web_app.backend.models import config_model
+from loaner.web_app.backend.models import tag_model
from loaner.web_app.backend.models import user_model
@@ -126,6 +127,10 @@ class DeviceReturnError(Error):
"""Raised when a device failed to be returned."""
+class DeviceAuditEventError(Error):
+ """Raised when the app fails to audit a device."""
+
+
ReturnDates = collections.namedtuple('ReturnDates', ['max', 'default'])
@@ -197,6 +202,8 @@ class Device(base_model.BaseModel):
last_reminder: Reminder, Level, time, and count of the last reminder
the device had.
next_reminder: Reminder, Level, time, and count of the next reminder.
+ tags: List[tag_model.Tag], a list of tags associated with the device.
+ onboarded: bool, indicates the onboarding status of the device.
"""
serial_number = ndb.StringProperty()
asset_tag = ndb.StringProperty()
@@ -218,6 +225,8 @@ class Device(base_model.BaseModel):
damaged_reason = ndb.StringProperty()
last_reminder = ndb.StructuredProperty(Reminder)
next_reminder = ndb.StructuredProperty(Reminder)
+ tags = ndb.StructuredProperty(tag_model.TagData, repeated=True)
+ onboarded = ndb.BooleanProperty(default=False)
_INDEX_NAME = constants.DEVICE_INDEX_NAME
_SEARCH_PARAMETERS = {
@@ -251,6 +260,10 @@ def identifier(self):
def guest_enabled(self):
return self.current_ou == constants.ORG_UNIT_DICT['GUEST']
+ @property
+ def return_dates(self):
+ return calculate_return_dates(self.assignment_date)
+
def _post_put_hook(self, future):
"""Overrides the _post_put_hook method."""
del future # Unused.
@@ -267,10 +280,7 @@ def list_by_user(cls, user):
Returns:
A query of devices assigned to the user.
"""
- return cls.query(
- ndb.AND(
- cls.assigned_user == user,
- cls.mark_pending_return_date == None)).fetch() # pylint: disable=g-equals-none,singleton-comparison
+ return cls.query(ndb.AND(cls.assigned_user == user)).fetch()
@classmethod
def enroll(cls, user_email, serial_number=None, asset_tag=None):
@@ -290,9 +300,9 @@ def enroll(cls, user_email, serial_number=None, asset_tag=None):
not found in the directory API.
"""
if serial_number:
- serial_number = serial_number.upper()
+ serial_number = serial_number.upper().strip()
if asset_tag:
- asset_tag = asset_tag.upper()
+ asset_tag = asset_tag.upper().strip()
device_identifier_mode = config_model.Config.get('device_identifier_mode')
if not asset_tag and device_identifier_mode in (
config_model.DeviceIdentifierMode.BOTH_REQUIRED,
@@ -470,15 +480,15 @@ def get(
invalid URL-safe key is supplied.
"""
if asset_tag:
- return cls.query(cls.asset_tag == asset_tag.upper()).get()
+ return cls.query(cls.asset_tag == asset_tag.upper().strip()).get()
elif chrome_device_id:
- return cls.query(cls.chrome_device_id == chrome_device_id).get()
+ return cls.query(cls.chrome_device_id == chrome_device_id.strip()).get()
elif serial_number:
- return cls.query(cls.serial_number == serial_number.upper()).get()
+ return cls.query(cls.serial_number == serial_number.upper().strip()).get()
elif identifier:
return (
- cls.query(cls.serial_number == identifier.upper()).get() or
- cls.query(cls.asset_tag == identifier.upper()).get())
+ cls.query(cls.serial_number == identifier.upper().strip()).get() or
+ cls.query(cls.asset_tag == identifier.upper().strip()).get())
else:
raise DeviceIdentifierError('No identifier supplied to get device.')
@@ -544,7 +554,7 @@ def loan_assign(self, user_email):
self.assignment_date = datetime.datetime.utcnow()
self.mark_pending_return_date = None
self.shelf = None
- self.due_date = calculate_return_dates(self.assignment_date).default
+ self.due_date = self.return_dates.default
self.move_to_default_ou(user_email=user_email)
event_action = 'device_loan_assign'
try:
@@ -610,10 +620,9 @@ def loan_extend(self, user_email, extend_date_time):
extend_date = extend_date_time.date()
if extend_date < datetime.date.today():
raise ExtendError('Extension date cannot be in the past.')
- return_dates = calculate_return_dates(self.assignment_date)
- if extend_date <= return_dates.max.date():
+ if extend_date <= self.return_dates.max.date():
self.due_date = datetime.datetime.combine(
- extend_date, return_dates.default.time())
+ extend_date, self.return_dates.default.time())
else:
raise ExtendError('Extension date outside allowable date range.')
self.put()
@@ -650,6 +659,7 @@ def _loan_return(self, user_email):
self.move_to_default_ou(user_email=user_email)
self.last_reminder = None
self.next_reminder = None
+ self.onboarded = False
self.put()
self.stream_to_bq(
user_email, 'Marking device %s as returned.' % self.identifier)
@@ -757,6 +767,17 @@ def mark_lost(self, user_email):
self.stream_to_bq(
user_email, 'Marking device %s lost and locking it.' % self.identifier)
+ def complete_onboard(self, user_email):
+ """Complete device onboarding.
+
+ Args:
+ user_email: str, The email of the acting user.
+ """
+ self.onboarded = True
+ self.put()
+ self.stream_to_bq(
+ user_email, 'Completing onboard of device %s.' % self.identifier)
+
@validate_assignee_or_admin
def enable_guest_mode(self, user_email):
"""Moves a device into guest mode if allowed.
@@ -838,11 +859,20 @@ def device_audit_check(self):
Raises:
DeviceNotEnrolledError: when a device is not enrolled in the application.
UnableToMoveToShelfError: when a deivce can not be checked into a shelf.
+ DeviceAuditError:when a device encounters an error during auditing
"""
if not self.enrolled:
raise DeviceNotEnrolledError(DEVICE_NOT_ENROLLED_MSG % self.identifier)
if self.damaged:
raise UnableToMoveToShelfError(_DEVICE_DAMAGED_MSG % self.identifier)
+ try:
+ events.raise_event('device_audit', device=self)
+ except events.EventActionsError as err:
+ # For any action that is implemented for device_audit that is
+ # required for the rest of the logic an error should be raised.
+ # If all actions are not required, eg sending a notification email only,
+ # the error should only be logged.
+ raise DeviceAuditEventError(err)
def move_to_shelf(self, shelf, user_email):
"""Checks a device into a shelf.
@@ -884,6 +914,57 @@ def remove_from_shelf(self, shelf, user_email):
user_email, 'Removing device: %s from shelf: %s' % (
self.identifier, shelf.location))
+ def associate_tag(self, user_email, tag_name, more_info=None):
+ """Associates a tag with a device.
+
+ Args:
+ user_email: str, the email of the user taking the action.
+ tag_name: str, the name of the tag to be associated.
+ more_info: str, an informational field about a particular tag reference.
+ """
+ tag_data = tag_model.TagData(
+ tag=tag_model.Tag.get(tag_name), more_info=more_info)
+ if tag_data not in self.tags:
+ for device_tag in self.tags:
+ if tag_name == device_tag.tag.name:
+ # Updates more_info field of an existing associated tag.
+ device_tag.more_info = more_info
+ self.put()
+ self.stream_to_bq(
+ user_email,
+ 'Updated more_info on tag %s to %s on device %s.' %
+ (tag_data.tag.name, more_info, self.identifier))
+ return
+ self.tags.append(tag_data)
+ self.put()
+ self.stream_to_bq(
+ user_email, 'Associated tag %s with device %s' %
+ (tag_data.tag.name, self.identifier))
+
+ def disassociate_tag(self, user_email, tag_name):
+ """Disassociates a tag from a device.
+
+ Args:
+ user_email: str, the email of the user taking the action.
+ tag_name: str, the name of the tag to be disassociated.
+
+ Raises:
+ ValueError: If the tag requested to be disassociated from the device is
+ not currently associated with the device.
+ """
+
+ for tag_reference in self.tags:
+ if tag_reference.tag.name == tag_name:
+ self.tags.remove(tag_reference)
+ self.put()
+ self.stream_to_bq(
+ user_email, 'Removed tag %s from device %s' %
+ (tag_reference.tag.name, self.identifier))
+ return
+ logging.warn(
+ 'Tag with name %s is not associated with device %s',
+ tag_name, self.identifier)
+
def _update_existing_device(device, user_email, asset_tag=None):
"""Updates an existing device entity during a re-enrollment.
@@ -927,12 +1008,12 @@ def calculate_return_dates(assignment_date):
Returns:
A ReturnDates NamedTuple of datetimes.
"""
- loan_duration = config_model.Config.get(
- 'loan_duration')
- max_loan_duration = config_model.Config.get(
- 'maximum_loan_duration')
- default_date = assignment_date + datetime.timedelta(days=loan_duration)
+ default_date = assignment_date + datetime.timedelta(
+ days=config_model.Config.get('loan_duration'))
max_loan_date = assignment_date + datetime.timedelta(
- days=max_loan_duration)
+ days=config_model.Config.get('maximum_loan_duration'))
+ if default_date.weekday() > 4:
+ days_til_weekday = ((default_date.weekday() - 4) % 2) + 1
+ default_date = default_date + datetime.timedelta(days=days_til_weekday)
return ReturnDates(max_loan_date, default_date)
diff --git a/loaner/web_app/backend/models/device_model_test.py b/loaner/web_app/backend/models/device_model_test.py
index 874e1505..ce427435 100644
--- a/loaner/web_app/backend/models/device_model_test.py
+++ b/loaner/web_app/backend/models/device_model_test.py
@@ -19,6 +19,7 @@
from __future__ import print_function
import datetime
+
from absl import logging
from absl.testing import parameterized
import freezegun
@@ -27,12 +28,14 @@
from google.appengine.api import datastore_errors
from google.appengine.api import search
from google.appengine.ext import deferred
+
from loaner.web_app import constants
from loaner.web_app.backend.clients import directory
from loaner.web_app.backend.lib import events
from loaner.web_app.backend.models import config_model
from loaner.web_app.backend.models import device_model
from loaner.web_app.backend.models import shelf_model
+from loaner.web_app.backend.models import tag_model
from loaner.web_app.backend.models import user_model
from loaner.web_app.backend.testing import loanertest
@@ -48,6 +51,19 @@ def setUp(self):
self.shelf = shelf_model.Shelf.enroll(
user_email=loanertest.USER_EMAIL, location='MTV', capacity=10,
friendly_name='MTV office')
+
+ self.tag1_key = tag_model.Tag(
+ name='TestTag1', hidden=False, protect=True,
+ color='blue', description='Description 1.').put()
+ self.tag2_key = tag_model.Tag(
+ name='TestTag2', hidden=False, protect=False,
+ color='red', description='Description 2.').put()
+
+ self.tag1_data = tag_model.TagData(
+ tag=self.tag1_key.get(), more_info='tag1_data info.')
+ self.tag2_data = tag_model.TagData(
+ tag=self.tag2_key.get(), more_info='tag2_data info.')
+
device_model.Device(
serial_number='12321', enrolled=True,
device_model='HP Chromebook 13 G1', current_ou='/',
@@ -57,15 +73,16 @@ def setUp(self):
serial_number='67890', enrolled=True,
device_model='Google Pixelbook', current_ou='/',
shelf=self.shelf.key, chrome_device_id='unique_id_2',
- damaged=False).put()
+ damaged=False, tags=[self.tag1_data]).put()
device_model.Device(
serial_number='VOID', enrolled=False,
device_model='HP Chromebook 13 G1', current_ou='/',
shelf=self.shelf.key, chrome_device_id='unique_id_8',
- damaged=False).put()
+ damaged=False, tags=[self.tag1_data, self.tag2_data]).put()
self.device1 = device_model.Device.get(serial_number='12321')
self.device2 = device_model.Device.get(serial_number='67890')
self.device3 = device_model.Device.get(serial_number='Void')
+
datastore_user = user_model.User.get_user(loanertest.USER_EMAIL)
datastore_user.update(superadmin=True)
@@ -120,7 +137,6 @@ def enroll_test_device(self, device_to_enroll):
self.mock_directoryclient.move_chrome_device_org_unit.called)
def test_identifier(self):
-
# Devices without an asset tag should return the serial number.
self.device1.asset_tag = None
self.assertEqual(self.device1.serial_number, self.device1.identifier)
@@ -129,6 +145,24 @@ def test_identifier(self):
self.device1.asset_tag = '123456'
self.assertEqual(self.device1.asset_tag, self.device1.identifier)
+ @mock.patch.object(directory, 'DirectoryApiClient', autospec=True)
+ def test_enroll_new_device_whitespace_identifiers(self, mock_directoryclass):
+ self.patcher_directory = mock.patch.object(
+ directory, 'DirectoryApiClient', autospec=True)
+ self.mock_directoryclass = self.patcher_directory.start()
+ self.addCleanup(self.patcher_directory.stop)
+ self.mock_directoryclient = self.mock_directoryclass.return_value
+ self.mock_directoryclient.get_chrome_device_by_serial.return_value = (
+ loanertest.TEST_DIR_DEVICE1)
+
+ test_device = device_model.Device.enroll(
+ user_email=loanertest.USER_EMAIL,
+ serial_number=' 123456 ',
+ asset_tag=' 123ABC ')
+ self.assertEqual(
+ device_model.Device.get(serial_number='123456'), test_device)
+ self.assertEqual(device_model.Device.get(asset_tag='123ABC'), test_device)
+
@mock.patch.object(logging, 'info')
def test_enroll_new_device(self, mock_loginfo):
self.enroll_test_device(loanertest.TEST_DIR_DEVICE1)
@@ -184,13 +218,11 @@ def test_enroll_unenrolled_device(
loanertest.TEST_DIR_DEVICE_DEFAULT)
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.serial_number = '123456'
- device.asset_tag = '123ABC'
- device.chrome_device_id = 'unique_id'
- device.put()
+ device_model.Device(
+ enrolled=False,
+ serial_number='123456',
+ asset_tag='123ABC',
+ chrome_device_id='unique_id').put()
self.assertEqual(mock_to_document.call_count, 1)
@@ -228,16 +260,14 @@ def special_side_effect(event_name, device=None, shelf=None):
loanertest.TEST_DIR_DEVICE_DEFAULT)
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.serial_number = '123456'
- device.chrome_device_id = 'unique_id'
- device.put()
+ device_model.Device(
+ enrolled=False,
+ serial_number='123456',
+ chrome_device_id='unique_id').put()
self.assertEqual(mock_to_document.call_count, 1)
- device = device_model.Device.enroll(
+ device_model.Device.enroll(
user_email=loanertest.USER_EMAIL, asset_tag='123ABC')
self.assertEqual(mock_logging.info.call_count, 2)
@@ -275,17 +305,15 @@ def special_side_effect(event_name, device=None, shelf=None):
loanertest.TEST_DIR_DEVICE_DEFAULT)
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.asset_tag = 'OLD_TAG'
- device.serial_number = '123456'
- device.chrome_device_id = 'unique_id'
- device.put()
+ device_model.Device(
+ enrolled=False,
+ serial_number='123456',
+ asset_tag='OLD_TAG',
+ chrome_device_id='unique_id').put()
self.assertEqual(mock_to_document.call_count, 1)
- device = device_model.Device.enroll(
+ device_model.Device.enroll(
user_email=loanertest.USER_EMAIL, asset_tag='123ABC')
self.assertEqual(mock_logging.info.call_count, 2)
@@ -306,13 +334,11 @@ def test_enroll_unenrolled_locked_device(
loanertest.TEST_DIR_DEVICE_DEFAULT)
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.locked = True
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.serial_number = '123456'
- device.chrome_device_id = 'unique_id'
- device.put()
+ device_model.Device(
+ locked=True,
+ enrolled=False,
+ serial_number='123456',
+ chrome_device_id='unique_id').put()
device = device_model.Device.enroll(
user_email=loanertest.USER_EMAIL, serial_number='123456')
@@ -332,13 +358,11 @@ def test_enroll_unenrolled_lost_device(
loanertest.TEST_DIR_DEVICE_DEFAULT)
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.lost = True
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.serial_number = '123456'
- device.chrome_device_id = 'unique_id'
- device.put()
+ device_model.Device(
+ lost=True,
+ enrolled=False,
+ serial_number='123456',
+ chrome_device_id='unique_id').put()
device = device_model.Device.enroll(
user_email=loanertest.USER_EMAIL, serial_number='123456')
@@ -355,13 +379,10 @@ def test_enroll_unenrolled_damaged_device(
mock_directoryclient = mock_directoryclass.return_value
mock_directoryclient.get_chrome_device_by_serial.return_value = (
loanertest.TEST_DIR_DEVICE_DEFAULT)
- device = device_model.Device()
- device.damaged = True
- device.enrolled = False
- device.serial_number = '123456'
- device.put()
- device = device_model.Device.enroll(
+ device_model.Device(
+ damaged=True, enrolled=False, serial_number='123456').put()
+ device_model.Device.enroll(
user_email=loanertest.USER_EMAIL, serial_number='123456')
retrieved_device = device_model.Device.get(serial_number='123456')
@@ -370,13 +391,11 @@ def test_enroll_unenrolled_damaged_device(
@mock.patch.object(directory, 'DirectoryApiClient', autospec=True)
def test_enroll_move_ou_error(self, mock_directoryclass):
- device = device_model.Device()
- device.enrolled = False
- device.model = 'HP Chromebook 13 G1'
- device.serial_number = '5467FD'
- device.chrome_device_id = 'unique_id_09'
- device.current_ou = 'not_default'
- device.put()
+ device_model.Device(
+ enrolled=False,
+ serial_number='5467FD',
+ chrome_device_id='unique_id_09',
+ current_ou='not_default').put()
err_message = 'Failed to move device'
mock_directoryclient = mock_directoryclass.return_value
mock_directoryclient.move_chrome_device_org_unit.side_effect = (
@@ -458,17 +477,6 @@ def test_list_by_user(self):
[device.serial_number for device in devices],
[self.device1.serial_number, self.device2.serial_number])
- def test_list_by_user_with_pending_return(self):
- self.device1.assigned_user = loanertest.SUPER_ADMIN_EMAIL
- self.device1.put()
- self.device2.assigned_user = loanertest.SUPER_ADMIN_EMAIL
- self.device2.mark_pending_return_date = datetime.datetime.utcnow()
- self.device2.put()
- devices = device_model.Device.list_by_user(loanertest.SUPER_ADMIN_EMAIL)
- self.assertListEqual(
- [device.serial_number for device in devices],
- [self.device1.serial_number])
-
@mock.patch.object(directory, 'DirectoryApiClient', autospec=True)
def test_create_unenrolled(self, mock_directoryclass):
"""Test creating an unenrolled device."""
@@ -527,7 +535,7 @@ def test_get(self):
device_model.Device.get(chrome_device_id='chrome_id_2').asset_tag,
'ASSET_TAG_2')
- # Identifier is can take either an asset tag or serial number.
+ # Identifier can take either an asset tag or serial number.
self.assertEqual(
device_model.Device.get(identifier='asset_tag_0').asset_tag,
'ASSET_TAG_0')
@@ -536,6 +544,32 @@ def test_get(self):
identifier='serial_number_1').serial_number,
'SERIAL_NUMBER_1')
+ def test_get_whitespace_identifiers(self):
+ whitespace_test_device = device_model.Device(
+ enrolled=False,
+ serial_number='123456',
+ asset_tag='ABCDE',
+ chrome_device_id='unique_id').put().get()
+
+ self.assertEqual(
+ device_model.Device.get(asset_tag=' ABCDE '),
+ whitespace_test_device)
+ self.assertEqual(
+ device_model.Device.get(serial_number=' 123456 '),
+ whitespace_test_device)
+ self.assertEqual(
+ device_model.Device.get(chrome_device_id=' unique_id '),
+ whitespace_test_device)
+
+ # Tests using the identifier argument with a serial number.
+ self.assertEqual(
+ device_model.Device.get(identifier=' ABCDE '),
+ whitespace_test_device)
+ # Tests using the identifier argument with an asset tag.
+ self.assertEqual(
+ device_model.Device.get(identifier=' 123456 '),
+ whitespace_test_device)
+
def test_is_overdue(self):
now = datetime.datetime(year=2017, month=1, day=1)
with freezegun.freeze_time(now):
@@ -570,9 +604,7 @@ def test_loan_assign(self):
self.assertTrue(retrieved_device.assignment_date)
self.assertEqual(retrieved_device.mark_pending_return_date, None)
self.assertEqual(
- retrieved_device.due_date,
- device_model.calculate_return_dates(
- self.test_device.assignment_date).default)
+ retrieved_device.due_date, self.test_device.return_dates.default)
self.assertIsNone(self.test_device.shelf)
self.assertEqual(self.testbed.mock_raiseevent.call_count, 1)
@@ -686,9 +718,7 @@ def test_extend_outside_range(self):
@mock.patch.object(device_model.Device, 'unlock', autospec=True)
def test_loan_return(self, mock_unlock):
- user_email = loanertest.USER_EMAIL
self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
- self.test_device.assigned_user = user_email
self.test_device.assignment_date = (
datetime.datetime(year=2017, month=1, day=1))
self.test_device.due_date = (
@@ -696,7 +726,7 @@ def test_loan_return(self, mock_unlock):
self.test_device.lost = True
self.test_device.locked = True
- self.test_device._loan_return(user_email)
+ self.test_device._loan_return(loanertest.USER_EMAIL)
retrieved_device = device_model.Device.get(serial_number='123456')
self.assertIsNone(retrieved_device.assigned_user)
@@ -929,6 +959,12 @@ def test_device_audit_check_device_is_damaged(self):
self.test_device.identifier)):
self.test_device.device_audit_check()
+ def test_device_audit_check_audit_error(self):
+ self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
+ self.testbed.mock_raiseevent.side_effect = events.EventActionsError
+ with self.assertRaises(device_model.DeviceAuditEventError):
+ self.test_device.device_audit_check()
+
def test_place_device_on_shelf_is_not_active(self):
self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
self.shelf.enabled = False
@@ -965,20 +1001,91 @@ def test_remove_from_shelf(self):
shelf=self.shelf, user_email=loanertest.USER_EMAIL)
self.assertIsNone(self.test_device.shelf)
+ def test_associate_tag(self):
+ self.device1.associate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag2_data.tag.name,
+ more_info=self.tag2_data.more_info)
+ self.assertIsInstance(self.device1.tags[0], tag_model.TagData)
+ self.assertCountEqual(
+ device_model.Device.get(serial_number='12321').tags, [self.tag2_data])
+
+ def test_associate_tag__additional(self):
+ self.device2.associate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag2_data.tag.name,
+ more_info=self.tag2_data.more_info)
+ self.assertCountEqual(
+ device_model.Device.get(serial_number='67890').tags,
+ [self.tag1_data, self.tag2_data])
+
+ def test_associate_tag__duplicate(self):
+ self.device2.associate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag1_data.tag.name,
+ more_info=self.tag1_data.more_info)
+ self.assertCountEqual(
+ device_model.Device.get(serial_number='67890').tags, [self.tag1_data])
+
+ def test_associate_tag__updated_info(self):
+ self.device2.associate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag1_data.tag.name,
+ more_info='different_more_info')
+ retrieved_device = device_model.Device.get(serial_number='67890')
+ self.assertCountEqual(retrieved_device.tags, [self.tag1_data])
+ self.assertEqual(retrieved_device.tags[0].more_info, 'different_more_info')
+
+ def test_disassociate_tag(self):
+ self.device3.disassociate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag2_data.tag.name)
+ self.assertCountEqual(
+ device_model.Device.get(serial_number='Void').tags, [self.tag1_data])
+
+ def test_disassociate_tag__not_associated(self):
+ with mock.patch.object(logging, 'warn', autospec=True) as mock_logging:
+ self.device1.disassociate_tag(
+ user_email=loanertest.USER_EMAIL,
+ tag_name=self.tag2_data.tag.name)
+ self.assertTrue(mock_logging.called)
+
@mock.patch.object(config_model, 'Config', autospec=True)
def test_calculate_return_dates(self, mock_config):
- now = datetime.datetime.utcnow()
+ now = datetime.datetime(year=2017, month=1, day=1)
self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
self.test_device.assignment_date = now
mock_config.get.side_effect = [3, 14]
- dates = device_model.calculate_return_dates(
- self.test_device.assignment_date)
-
+ dates = self.test_device.return_dates
self.assertIsInstance(dates, device_model.ReturnDates)
self.assertEqual(dates.default, now + datetime.timedelta(days=3))
self.assertEqual(dates.max, now + datetime.timedelta(days=14))
+ @mock.patch.object(config_model, 'Config', autospec=True)
+ def test_calculate_return_dates_on_saturday_date(self, mock_config):
+ now = datetime.datetime(year=2019, month=1, day=2)
+ self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
+ self.test_device.assignment_date = now
+ mock_config.get.side_effect = [3, 14]
+
+ dates = self.test_device.return_dates
+ self.assertIsInstance(dates, device_model.ReturnDates)
+ self.assertEqual(dates.default, now + datetime.timedelta(days=5))
+ self.assertEqual(dates.max, now + datetime.timedelta(days=14))
+
+ @mock.patch.object(config_model, 'Config', autospec=True)
+ def test_calculate_return_dates_on_sunday_date(self, mock_config):
+ now = datetime.datetime(year=2019, month=1, day=3)
+ self.enroll_test_device(loanertest.TEST_DIR_DEVICE_DEFAULT)
+ self.test_device.assignment_date = now
+ mock_config.get.side_effect = [3, 14]
+
+ dates = self.test_device.return_dates
+ self.assertIsInstance(dates, device_model.ReturnDates)
+ self.assertEqual(dates.default, now + datetime.timedelta(days=4))
+ self.assertEqual(dates.max, now + datetime.timedelta(days=14))
+
class DecoratorTest(loanertest.TestCase):
"""Tests for decorators."""
@@ -993,8 +1100,7 @@ class TestDevice(device_model.Device):
def testable_method(self):
return True
- self.test_device = TestDevice()
- self.test_device.assigned_user = loanertest.USER_EMAIL
+ self.test_device = TestDevice(assigned_user=loanertest.USER_EMAIL)
@mock.patch.object(
device_model.user_lib, 'get_user_email',
diff --git a/loaner/web_app/backend/models/fleet_model.py b/loaner/web_app/backend/models/fleet_model.py
new file mode 100644
index 00000000..5297dbdd
--- /dev/null
+++ b/loaner/web_app/backend/models/fleet_model.py
@@ -0,0 +1,122 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""A model representing a fleet organization."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from google.appengine.ext import ndb
+from loaner.web_app.backend.models import base_model
+
+
+class Error(Exception):
+ """Base error class for the module."""
+
+
+class CreateFleetError(Error):
+ """When a Fleet cannot be created."""
+
+
+class Fleet(base_model.BaseModel):
+ """Model for a fleet organization.
+
+ Attributes:
+ config: list|ndb.key|, The list of fleet specific config models.
+ description: str, Optional text description of fleet.
+ display_name: str, Optional display name, defaults to self.name.
+ """
+ config = ndb.KeyProperty(kind='Config', repeated=True)
+ description = ndb.StringProperty()
+ display_name = ndb.StringProperty()
+
+ @property
+ def name(self):
+ """String name of Fleet organization."""
+ return self.key.string_id()
+
+ @classmethod
+ def create(cls, acting_user, name, config,
+ description=None, display_name=None):
+ """Creates a new Fleet.
+
+ Args:
+ acting_user: str, email address of the user making the request.
+ name: str, name of the Fleet.
+ config: list|ndb.key|, The list of fleet specific config models.
+ description: str, Optional text description of fleet.
+ display_name: str, Optional display name, defaults to self.name.
+
+ Returns:
+ Created Fleet.
+
+ Raises:
+ CreateFleetError: If the fleet fails to be created.
+ """
+ if not name or not isinstance(name, str):
+ raise CreateFleetError('Fleet name is invalid.', name)
+ if cls.get_by_name(name):
+ raise CreateFleetError('Fleet organization already exists', name)
+ new_fleet = cls(
+ key=ndb.Key(cls, name),
+ config=config or [],
+ description=description,
+ display_name=display_name or name)
+ new_fleet.put()
+ new_fleet.stream_to_bq(acting_user, 'Created fleet %s' % display_name)
+ return new_fleet
+
+ @classmethod
+ def default(cls, acting_user, display_name, description=None):
+ """Creates a Fleet with default settings.
+
+ Args:
+ acting_user: str, email address of the user making the request.
+ display_name: str, Required display name for default fleet.
+ description: str, Optional text description of fleet.
+
+ Returns:
+ The default fleet.
+
+ Raises:
+ CreateFleetError: If the fleet fails to be created.
+ """
+ return cls.create(
+ acting_user=acting_user,
+ name='default',
+ config=[], # The default fleet uses only config_defaults settings.
+ description=description or 'The default fleet organization',
+ display_name=display_name)
+
+ @classmethod
+ def get_by_name(cls, name):
+ """Gets a fleet by its name.
+
+ Args:
+ name: str, name of the fleet.
+
+ Returns:
+ Fleet object.
+ """
+ return ndb.Key(cls, name).get()
+
+ @classmethod
+ def list_all_fleets(cls):
+ """Returns all fleets in datastore.
+
+ Returns:
+ List of Fleets.
+ """
+ return cls.query().fetch()
diff --git a/loaner/web_app/backend/models/fleet_model_test.py b/loaner/web_app/backend/models/fleet_model_test.py
new file mode 100644
index 00000000..04a82aba
--- /dev/null
+++ b/loaner/web_app/backend/models/fleet_model_test.py
@@ -0,0 +1,127 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""Tests for backend.models.fleet_model."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from loaner.web_app.backend.models import config_model
+from loaner.web_app.backend.models import fleet_model
+from loaner.web_app.backend.testing import loanertest
+
+
+class FleetModelTest(loanertest.TestCase):
+
+ def setUp(self):
+ super(FleetModelTest, self).setUp()
+ self.config1 = config_model.Config(
+ id='string_config', string_value='config value 1').put()
+ self.config2 = config_model.Config(
+ id='integer_config', integer_value=1).put()
+
+ def test_fleet_name(self):
+ """Fleet name should be returned as a string."""
+ expected_name = 'empty_example'
+ empty_fleet = fleet_model.Fleet.create(
+ loanertest.TECHNICAL_ADMIN_EMAIL, expected_name, None, None)
+ actual_name = empty_fleet.name
+ self.assertEqual(actual_name, expected_name)
+
+ def test_create_fleet(self):
+ """Test creating a nominal fleet object."""
+ expected_name = 'example_fleet'
+ expected_desc = 'A newly created fleet used in a test.'
+ expected_configs = [self.config1, self.config2]
+ created_fleet = fleet_model.Fleet.create(loanertest.TECHNICAL_ADMIN_EMAIL,
+ expected_name,
+ expected_configs,
+ expected_desc)
+ self.assertEqual(created_fleet.name, expected_name)
+ self.assertEqual(created_fleet.config, expected_configs)
+ self.assertEqual(created_fleet.description, expected_desc)
+ self.assertEqual(created_fleet.display_name, expected_name)
+
+ def test_create_fleet__display_name(self):
+ """Test defining an alternate display_name for Fleet."""
+ expected_display_name = 'something_else'
+ created_fleet = fleet_model.Fleet.create(
+ loanertest.TECHNICAL_ADMIN_EMAIL, 'example_fleet', None,
+ display_name=expected_display_name)
+ self.assertEqual(created_fleet.display_name, expected_display_name)
+
+ def test_create_fleet__name_exists(self):
+ """Creating a fleet with a duplicate name should raise CreateFleetError."""
+ fleet_model.Fleet.create(loanertest.TECHNICAL_ADMIN_EMAIL,
+ 'example_fleet', None)
+ self.assertRaises(fleet_model.CreateFleetError,
+ fleet_model.Fleet.create,
+ loanertest.TECHNICAL_ADMIN_EMAIL,
+ 'example_fleet', None)
+
+ def test_create_fleet__name_blank(self):
+ """Creating a fleet with an blank name should raise CreateFleetError."""
+ self.assertRaises(fleet_model.CreateFleetError,
+ fleet_model.Fleet.create,
+ loanertest.TECHNICAL_ADMIN_EMAIL, '', None)
+ self.assertRaises(fleet_model.CreateFleetError,
+ fleet_model.Fleet.create,
+ loanertest.TECHNICAL_ADMIN_EMAIL, None, None)
+
+ def test_create_fleet__name_invalid(self):
+ """Creating a fleet with a non-str name should raise CreateFleetError."""
+ self.assertRaises(fleet_model.CreateFleetError,
+ fleet_model.Fleet.create,
+ loanertest.TECHNICAL_ADMIN_EMAIL, 10, None)
+
+ def test_fleet_get_by_name(self):
+ """Test fetching a fleet object by name."""
+ expected_name = 'empty_example'
+ expected_fleet = fleet_model.Fleet.create(
+ loanertest.TECHNICAL_ADMIN_EMAIL, expected_name, None)
+ actual_fleet = fleet_model.Fleet.get_by_name(expected_name)
+ self.assertEqual(actual_fleet, expected_fleet)
+ self.assertEqual(actual_fleet.name, expected_name)
+
+ def test_list_all_fleets(self):
+ """Test fetching a list of all fleet objects."""
+ expected_fleet_names = ['larry', 'curly', 'moe']
+ expected_fleets = []
+ for name in expected_fleet_names:
+ expected_fleets.append(fleet_model.Fleet.create(
+ loanertest.TECHNICAL_ADMIN_EMAIL, name, None, None))
+ actual_fleets = fleet_model.Fleet.list_all_fleets()
+ self.assertCountEqual(actual_fleets, expected_fleets)
+
+ def test_create_default_fleet(self):
+ """Test creating the default fleet object."""
+ expected_display_name = 'Google'
+ actual_fleet = fleet_model.Fleet.default(loanertest.TECHNICAL_ADMIN_EMAIL,
+ expected_display_name)
+ self.assertEqual(actual_fleet.name, 'default')
+ self.assertEqual(actual_fleet.config, [])
+ self.assertEqual(actual_fleet.description, 'The default fleet organization')
+ self.assertEqual(actual_fleet.display_name, expected_display_name)
+
+ def test_create_default_fleet__repeated(self):
+ """Recreating the default fleet object should raise CreateFleetError."""
+ fleet_model.Fleet.default(loanertest.TECHNICAL_ADMIN_EMAIL, 'example')
+ self.assertRaises(fleet_model.CreateFleetError,
+ fleet_model.Fleet.default,
+ loanertest.TECHNICAL_ADMIN_EMAIL, 'another example')
+
+
+if __name__ == '__main__':
+ loanertest.main()
diff --git a/loaner/web_app/backend/models/shelf_model.py b/loaner/web_app/backend/models/shelf_model.py
index 3da22e28..e9905849 100644
--- a/loaner/web_app/backend/models/shelf_model.py
+++ b/loaner/web_app/backend/models/shelf_model.py
@@ -122,6 +122,11 @@ def longitude(self):
return None
return self.lat_long.lon
+ @property
+ def audit_enabled(self):
+ return self.audit_notification_enabled and config_model.Config.get(
+ 'shelf_audit')
+
@property
def audited(self):
"""If the shelf has been audited.
diff --git a/loaner/web_app/backend/models/shelf_model_test.py b/loaner/web_app/backend/models/shelf_model_test.py
index 23a59fbb..16106195 100644
--- a/loaner/web_app/backend/models/shelf_model_test.py
+++ b/loaner/web_app/backend/models/shelf_model_test.py
@@ -283,6 +283,18 @@ def test_enable(self, mock_logging, mock_stream):
self.test_shelf, loanertest.USER_EMAIL,
shelf_model._ENABLE_MSG % self.test_shelf.identifier)
+ @parameterized.parameters(
+ (True, True, True), (True, False, False), (False, False, False))
+ @mock.patch.object(shelf_model.Shelf, 'stream_to_bq', autospec=True)
+ @mock.patch.object(shelf_model, 'logging', autospec=True)
+ def test_audit_enabled(
+ self, system_value, shelf_value, final_value, mock_logging, mock_stream):
+ """Testing the audit_enabled property with different configurations."""
+ config_model.Config.set('shelf_audit', system_value)
+ self.test_shelf.audit_notification_enabled = shelf_value
+ # Ensure the shelf audit notification status is equal to the expected value.
+ self.assertEqual(self.test_shelf.audit_enabled, final_value)
+
@mock.patch.object(shelf_model.Shelf, 'stream_to_bq', autospec=True)
@mock.patch.object(shelf_model, 'logging', autospec=True)
def test_disable(self, mock_logging, mock_stream):
diff --git a/loaner/web_app/backend/models/tag_model.py b/loaner/web_app/backend/models/tag_model.py
index 152f020e..a2916121 100644
--- a/loaner/web_app/backend/models/tag_model.py
+++ b/loaner/web_app/backend/models/tag_model.py
@@ -19,12 +19,12 @@
from __future__ import print_function
import logging
+import math
from google.appengine.api import datastore_errors
from google.appengine.ext import deferred
from google.appengine.ext import ndb
-from loaner.web_app.backend.lib import api_utils
from loaner.web_app.backend.models import base_model
@@ -67,6 +67,9 @@ def create(
Returns:
The new Tag entity.
+
+ Raises:
+ datastore_errors.BadValueError: If the tag name is an empty string.
"""
tag = cls(
name=name,
@@ -74,22 +77,24 @@ def create(
protect=protect,
color=color,
description=description)
+ if not name:
+ raise datastore_errors.BadValueError('The tag name must not be empty.')
tag.put()
logging.info('Creating a new tag with name %r.', name)
tag.stream_to_bq(user_email, 'Created a new tag with name %r.' % name)
return tag
@classmethod
- def get(cls, urlsafe_key):
- """Gets a Tag by its urlsafe key.
+ def get(cls, name):
+ """Gets a Tag by its name.
Args:
- urlsafe_key: str, the urlsafe encoding of the requested tag's ndb.Key.
+ name: str, the name of the tag.
Returns:
A Tag model entity.
"""
- return api_utils.get_ndb_key(urlsafe_key).get()
+ return cls.query(cls.name == name).get()
def update(self, user_email, **kwargs):
"""Updates an existing tag.
@@ -97,7 +102,13 @@ def update(self, user_email, **kwargs):
Args:
user_email: str, email of the user creating the tag.
**kwargs: kwargs for the update API.
+
+ Raises:
+ datastore_errors.BadValueError: If the tag name is an empty string.
"""
+ if not kwargs['name']:
+ raise datastore_errors.BadValueError('The tag name must not be empty.')
+
if kwargs['name'] != self.name:
logging.info(
'Renaming the tag with name %r to %r.', self.name, kwargs['name'])
@@ -135,37 +146,69 @@ def _pre_delete_hook(cls, key):
'Destroying the tag with urlsafe key %r and name %r.',
key.urlsafe(), key.get().name)
for model in _MODELS_WITH_TAGS:
- deferred.defer(_delete_tags, model, key)
+ deferred.defer(_delete_tags, model, key.get())
+
+ @classmethod
+ def list(cls, page_size=10, page_index=1, include_hidden_tags=False,
+ cursor=None):
+ """Fetches tags entities from datastore.
+ Args:
+ page_size: int, The number of results to return.
+ page_index: int, The page index to offset the results from.
+ include_hidden_tags: bool, Whether to include hidden tags in the results.
+ cursor: Optional[datastore_query.Cursor], pointing to the last
+ result.
+
+ Returns:
+ A tuple of a list of Tag instances, a datastore_query.Cursor instance,
+ and a boolean representing whether or not there are additional results to
+ retrieve. For example:
-def _delete_tags(model, key, cursor=None, num_updated=0, batch_size=100):
+ ([tag_model.Tag instance_1, ..., tag_model.Tag instance_pagesize - 1],
+ datastore_query.Cursor instance,
+ True)
+ """
+ query_object = cls.query()
+ if not include_hidden_tags:
+ query_object = query_object.filter(cls.hidden == False) # pylint: disable=singleton-comparison,g-explicit-bool-comparison
+ return query_object.fetch_page(
+ page_size=page_size, start_cursor=cursor,
+ offset=(page_index - 1) * page_size), int(
+ math.ceil(query_object.count() / page_size))
+
+
+def _delete_tags(model, tag, cursor=None, num_updated=0, batch_size=100):
"""Cleans up any entities on the given model that reference the given key.
Args:
model: ndb.Model, a Model with a repeated TagData property.
- key: ndb.Key, a Tag model key.
+ tag: Tag, an instance of a Tag model.
cursor: Optional[datastore_query.Cursor], pointing to the last result.
num_updated: int, the number of entities that were just updated.
batch_size: int, the number of entities to include in the batch.
"""
entities, next_cursor, more = model.query(
- model.tags.tag_key == key).fetch_page(batch_size, start_cursor=cursor)
+ model.tags.tag == tag).fetch_page(batch_size, start_cursor=cursor)
+
for entity in entities:
- entity.tags = [tag for tag in entity.tags if tag.tag_key != key]
+ entity.tags = [
+ model_tag for model_tag in entity.tags if model_tag.tag != tag
+ ]
ndb.put_multi(entities)
num_updated += len(entities)
logging.info(
'Destroyed %d occurrence(s) of the tag with URL safe key %r',
- len(entities), key.urlsafe())
+ len(entities), tag.key.urlsafe())
if more:
deferred.defer(
- _delete_tags, model, key,
+ _delete_tags, model, tag,
cursor=next_cursor, num_updated=num_updated, batch_size=batch_size)
else:
logging.info(
'Destroyed a total of %d occurrence(s) of the tag with URL safe key %r',
- num_updated, key.urlsafe())
+ num_updated, tag.key.urlsafe())
class TagData(ndb.Model):
@@ -175,8 +218,8 @@ class TagData(ndb.Model):
the property name must be 'tags'.
Attributes:
- tag_key: ndb.Key, a reference to a Tag entity.
+ tag: Tag, an instance of a Tag entity.
more_info: str, an informational field about this particular tag reference.
"""
- tag_key = ndb.KeyProperty(Tag)
+ tag = ndb.StructuredProperty(Tag)
more_info = ndb.StringProperty()
diff --git a/loaner/web_app/backend/models/tag_model_py23_migration_test.py b/loaner/web_app/backend/models/tag_model_py23_migration_test.py
new file mode 100644
index 00000000..b16a8a2a
--- /dev/null
+++ b/loaner/web_app/backend/models/tag_model_py23_migration_test.py
@@ -0,0 +1,149 @@
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# 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.
+
+# Lint as: python3
+"""Tests for web_app.backend.models.tag_model_py23_migration."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+import mock
+from loaner.web_app.backend.models import tag_model
+from absl.testing import absltest
+
+
+class TagModelPy23MigrationTest(absltest.TestCase):
+
+ def setUp(self):
+ super(TagModelPy23MigrationTest, self).setUp()
+ self.tag = tag_model.Tag(
+ name='TestTag1',
+ hidden=False,
+ protect=True,
+ color='blue',
+ description='Description 1.')
+
+ @mock.patch.object(tag_model.ndb.Model, 'put')
+ @mock.patch.object(tag_model.base_model.BaseModel, 'stream_to_bq')
+ def testCreate(self, stream_to_bq_mock, model_put_mock):
+ user_email = 'test@google.com'
+ name = 'name'
+ hidden = False
+ protect = True
+ color = 'grey'
+ tag = tag_model.Tag.create(
+ user_email, name, hidden, protect, color, description=None)
+ stream_to_bq_mock.assert_called_once_with(
+ 'test@google.com', "Created a new tag with name 'name'.")
+ model_put_mock.assert_called_once_with()
+ self.assertEqual('grey', tag.color)
+ self.assertEqual(False, tag.hidden)
+ self.assertEqual(True, tag.protect)
+
+ @mock.patch.object(tag_model.ndb.Model, 'put')
+ @mock.patch.object(tag_model.base_model.BaseModel, 'stream_to_bq')
+ @mock.patch.object(tag_model.Tag, 'key')
+ def testUpdate(self, key_mock, stream_to_bq_mock, model_put_mock):
+ self.tag.update(
+ user_email='test@google.com',
+ hidden=False,
+ protect=False,
+ color='blue',
+ description='A new description.',
+ name='TestTag2')
+ stream_to_bq_mock.assert_called_once_with(
+ 'test@google.com', "Updated a tag with name 'TestTag2'.")
+ model_put_mock.assert_called_once_with()
+ key_mock.urlsafe.assert_called_once_with()
+
+ @mock.patch.object(tag_model.Tag, 'query')
+ def testPrePutHook(self, query_mock):
+ self.tag = tag_model.Tag(
+ name='TestTag3',
+ hidden=False,
+ protect=False,
+ color='red',
+ description='Description 2.')
+ query_mock.return_value.get.return_value = False
+ self.tag.name = 'test123'
+ self.tag._pre_put_hook()
+ query_mock.return_value.get.assert_called_once_with(keys_only=True)
+
+ @mock.patch.object(tag_model.ndb, 'Key')
+ @mock.patch.object(tag_model.logging, 'info')
+ def testPreDeleteHook(self, info_mock, key_mock):
+ self.tag = tag_model.Tag(
+ name='TestTag3',
+ hidden=False,
+ protect=False,
+ color='red',
+ description='Description 2.')
+ key_mock.urlsafe.return_value = 'test'
+ key_mock.get.return_value.name = 'test_name'
+ self.tag._pre_delete_hook(key_mock)
+ info_mock.assert_called_once_with(
+ 'Destroying the tag with urlsafe key %r and name %r.', 'test',
+ 'test_name')
+ key_mock.urlsafe.assert_called_once_with()
+
+ @mock.patch.object(tag_model.Tag, 'query')
+ def testList(self, query_mock):
+ query_mock.return_value.fetch_page.return_value = 1
+ tag_model.Tag.list(page_size=1, include_hidden_tags=True)
+ query_mock.return_value.fetch_page.assert_called_once_with(
+ offset=0, page_size=1, start_cursor=None)
+
+ @mock.patch.object(tag_model.logging, 'info')
+ @mock.patch.object(tag_model.deferred, 'defer')
+ @mock.patch.object(tag_model.ndb, 'put_multi')
+ def testDeleteTags(self, mock_ndb, mock_defer, mock_info):
+ tag_mock = mock.Mock()
+ tag_mock.key.urlsafe.return_value = 'http://test.com'
+ model_tag_mock = mock.Mock(tags='test')
+ entity_mock = mock.Mock()
+ entity_mock.tags = [model_tag_mock]
+ model_mock = mock.Mock()
+ model_mock.query.return_value.fetch_page.return_value = ([entity_mock],
+ 'test', True)
+ tag_model._delete_tags(model_mock, tag=tag_mock, batch_size=2)
+ mock_defer.assert_called_once_with(
+ tag_model._delete_tags,
+ model_mock,
+ tag_mock,
+ batch_size=2,
+ cursor='test',
+ num_updated=1)
+ model_mock.query.return_value.fetch_page.assert_called_once_with(
+ 2, start_cursor=None)
+ mock_ndb.assert_called_once_with([entity_mock])
+ mock_info.assert_called_once_with(
+ 'Destroyed %d occurrence(s) of the tag with URL safe key %r', 1,
+ 'http://test.com')
+
+
+class TestTagData(absltest.TestCase):
+
+ def testTagDate(self):
+
+ tag_model_object = tag_model.Tag(
+ name='TestTag1', hidden=False, protect=True,
+ color='blue', description='Description 1.')
+
+ tag = tag_model.TagData(tag=tag_model_object, more_info='test_data')
+ self.assertEqual('test_data', tag.more_info)
+ self.assertEqual(tag_model_object, tag.tag)
+
+
+if __name__ == '__main__':
+ absltest.main()
diff --git a/loaner/web_app/backend/models/tag_model_test.py b/loaner/web_app/backend/models/tag_model_test.py
index 2db215d1..dac2ea90 100644
--- a/loaner/web_app/backend/models/tag_model_test.py
+++ b/loaner/web_app/backend/models/tag_model_test.py
@@ -23,6 +23,7 @@
import mock
from google.appengine.api import datastore_errors
+from google.appengine.datastore import datastore_query
from google.appengine.ext import deferred
from google.appengine.ext import ndb
@@ -47,16 +48,32 @@ def setUp(self):
self.tag1 = tag_model.Tag(
name='TestTag1', hidden=False, protect=True,
color='blue', description='Description 1.')
+ self.tag1.put()
+
self.tag2 = tag_model.Tag(
name='TestTag2', hidden=False, protect=False,
color='red', description='Description 2.')
- self.tag1.put()
self.tag2.put()
+ self.tag3 = tag_model.Tag(
+ name='TestTag3', hidden=True, protect=False,
+ color='yellow', description='Description 3.')
+ self.tag3.put()
+
+ self.tag4 = tag_model.Tag(
+ name='TestTag4', hidden=True, protect=True,
+ color='green', description='Description 4.')
+ self.tag4.put()
+
+ self.tag5 = tag_model.Tag(
+ name='TestTag5', hidden=False, protect=False,
+ color='red', description='Description 5.')
+ self.tag5.put()
+
self.tag1_data = tag_model.TagData(
- tag_key=self.tag1.key, more_info='tag1_data info.')
+ tag=self.tag1, more_info='tag1_data info.')
self.tag2_data = tag_model.TagData(
- tag_key=self.tag2.key, more_info='tag2_data info.')
+ tag=self.tag2, more_info='tag2_data info.')
self.entity1 = _ModelWithTags(
tags=[self.tag1_data, self.tag2_data]).put().get()
@@ -70,14 +87,13 @@ def test_create(self, mock_stream_to_bq):
"""Test the creation of a Tag."""
tag_entity = tag_model.Tag.create(
user_email=loanertest.USER_EMAIL,
- name='TestTag4',
+ name='NewlyCreatedTag',
hidden=False,
protect=False,
color='red',
- description='Description 4.')
+ description='Description for new tag.')
self.assertEqual(
- tag_entity, tag_model.Tag.get(
- urlsafe_key=tag_entity.key.urlsafe()))
+ tag_entity, tag_model.Tag.get('NewlyCreatedTag'))
self.assertEqual(mock_stream_to_bq.call_count, 1)
def test_create_existing(self):
@@ -91,6 +107,17 @@ def test_create_existing(self):
color='red',
description='A description.')
+ def test_create_tag_name_with_empty_string(self):
+ """Test the creation of a Tag with an empty string."""
+ with self.assertRaises(datastore_errors.BadValueError):
+ tag_model.Tag.create(
+ user_email=loanertest.USER_EMAIL,
+ name='',
+ hidden=False,
+ protect=False,
+ color='red',
+ description='A description.')
+
def test_update(self):
"""Test updating a Tag."""
self.tag2.update(
@@ -117,7 +144,7 @@ def test_update_new_name(self):
name='TestTag1 Renamed')
self.assertIn(
tag_model.TagData(
- tag_key=self.tag1.key, more_info=self.tag1_data.more_info),
+ tag=self.tag1, more_info=self.tag1_data.more_info),
self.entity1.tags)
self.assertEqual(self.tag1.name, 'TestTag1 Renamed')
@@ -132,21 +159,31 @@ def test_update_new_name_fail(self):
description='A new description.',
name='TestTag1')
+ def test_update_tag_name_with_empty_string(self):
+ """Test updating a Tag with an empty string."""
+ with self.assertRaises(datastore_errors.BadValueError):
+ self.tag2.update(
+ user_email=loanertest.USER_EMAIL,
+ hidden=False,
+ protect=False,
+ color='red',
+ description='A new description.',
+ name='')
+
@parameterized.parameters(
('TestTag1', 'tag1_data info.'),
('TestTag2', 'tag2_data info.'),
)
@mock.patch.object(ndb, 'put_multi', autospec=True)
- def test_destroy(self, tag, tag_info, mock_put_multi):
+ def test_destroy(self, tag_name, tag_info, mock_put_multi):
"""Test destroying an existing Tag using deferred tasks."""
- tag_key = tag_model.Tag.query(tag_model.Tag.name == tag).get().key
- tag_key.delete()
+ tag_entity = tag_model.Tag.query(tag_model.Tag.name == tag_name).get()
+ tag_entity.key.delete()
tasks = self.taskqueue_stub.get_filtered_tasks()
deferred.run(tasks[0].payload)
-
- tag_data = tag_model.TagData(tag_key=tag_key, more_info=tag_info)
- self.assertIsNone(tag_key.get())
+ tag_data = tag_model.TagData(tag=tag_entity, more_info=tag_info)
+ self.assertIsNone(tag_entity.key.get())
self.assertNotIn(tag_data, self.entity1.tags)
self.assertNotIn(tag_data, self.entity2.tags)
self.assertNotIn(tag_data, self.entity3.tags)
@@ -156,7 +193,7 @@ def test_destroy(self, tag, tag_info, mock_put_multi):
def test_delete_tags(self):
"""Test destroying a Tag in small batches to test multiple defer calls."""
tag_model._delete_tags(
- _ModelWithTags, key=self.tag1.key, batch_size=2)
+ _ModelWithTags, tag=self.tag1, batch_size=2)
tasks = self.taskqueue_stub.get_filtered_tasks()
deferred.run(tasks[0].payload)
deferred.run(tasks[0].payload)
@@ -164,5 +201,78 @@ def test_delete_tags(self):
self.assertNotIn(self.tag1_data, self.entity2.tags)
self.assertNotIn(self.tag1_data, self.entity3.tags)
+ def test_get_tag(self):
+ self.assertEqual(
+ tag_model.Tag.get(self.tag1.name), self.tag1)
+
+ def test_get_tag_get_none(self):
+ self.assertIsNone(tag_model.Tag.get('nothing'))
+
+ def test_list_tags_include_hidden(self):
+ (query_results, cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=tag_model.Tag.query().count(), include_hidden_tags=True)
+ self.assertListEqual(
+ query_results, [self.tag1, self.tag2, self.tag3, self.tag4, self.tag5])
+ self.assertEqual(total_pages, 1)
+ self.assertIsInstance(cursor, datastore_query.Cursor)
+ self.assertFalse(has_additional_results)
+
+ def test_list_tags_exclude_hidden(self):
+ (query_results, cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=tag_model.Tag.query().count(), include_hidden_tags=False)
+ self.assertListEqual(query_results, [self.tag1, self.tag2, self.tag5])
+ self.assertNotIn(self.tag3, query_results)
+ self.assertNotIn(self.tag4, query_results)
+ self.assertIsInstance(cursor, datastore_query.Cursor)
+ self.assertFalse(has_additional_results)
+ self.assertEqual(total_pages, 1)
+
+ def test_list_tags_more(self):
+ (page_one_result, first_cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=1, cursor=None, include_hidden_tags=False)
+ self.assertListEqual(page_one_result, [self.tag1])
+ self.assertTrue(has_additional_results)
+ self.assertEqual(total_pages, 3)
+
+ (page_two_result, next_cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=tag_model.Tag.query().count(), cursor=first_cursor,
+ include_hidden_tags=False)
+ self.assertListEqual(page_two_result, [self.tag2, self.tag5])
+ self.assertIsInstance(next_cursor, datastore_query.Cursor)
+ self.assertFalse(has_additional_results)
+ self.assertEqual(total_pages, 1)
+
+ def test_list_tags_middle_page(self):
+ (page_result, next_cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=1, page_index=2, include_hidden_tags=False)
+ self.assertListEqual(page_result, [self.tag2])
+ self.assertIsInstance(next_cursor, datastore_query.Cursor)
+ self.assertTrue(has_additional_results)
+ self.assertEqual(total_pages, 3)
+
+ def test_list_tags_last_page(self):
+ (page_result, next_cursor,
+ has_additional_results), total_pages = tag_model.Tag.list(
+ page_size=2, page_index=2, include_hidden_tags=False)
+ self.assertListEqual(page_result, [self.tag5])
+ self.assertIsInstance(next_cursor, datastore_query.Cursor)
+ self.assertFalse(has_additional_results)
+ self.assertEqual(total_pages, 2)
+
+ def test_list_tags_none(self):
+ ndb.delete_multi(tag_model.Tag.query().fetch(keys_only=True))
+ (query_results, cursor,
+ has_additional_results), total_pages = tag_model.Tag.list()
+ self.assertEmpty(query_results)
+ self.assertIsNone(cursor)
+ self.assertFalse(has_additional_results)
+ self.assertEqual(total_pages, 0)
+
+
if __name__ == '__main__':
loanertest.main()
diff --git a/loaner/web_app/backend/models/template_model.py b/loaner/web_app/backend/models/template_model.py
index 47f5be49..66b77b7c 100644
--- a/loaner/web_app/backend/models/template_model.py
+++ b/loaner/web_app/backend/models/template_model.py
@@ -18,9 +18,11 @@
from __future__ import division
from __future__ import print_function
+import logging
import re
import jinja2
+from google.appengine.api import datastore_errors
from google.appengine.api import memcache
from google.appengine.ext import ndb
@@ -42,41 +44,93 @@ class Template(ndb.Model):
"""Model representing a template."""
title = ndb.StringProperty()
body = ndb.TextProperty()
+ cached_templates = []
+
+ def __init__(self, *args, **kwds):
+ super(Template, self).__init__(*args, **kwds)
+ self.jinja = jinja2.Environment(
+ loader=jinja2.FunctionLoader(self._get_subtemplate), autoescape=True)
@property
def name(self):
"""Pseudo-property for name, from the ID."""
return self.key.id()
- @classmethod
- def create(cls, name, title=None, body=None):
- """Creates a model and entity."""
- entity = cls.get_or_insert(name)
- entity.title = title
- entity.body = body
- entity.put()
- return entity
-
-
-class TemplateLoader(object):
- """Loader for Jinja2 templates."""
-
- def __init__(self):
- self.jinja = jinja2.Environment(
- loader=jinja2.FunctionLoader(self._get_subtemplate), autoescape=True)
- self.templates_cached = False
-
- def _cache_template(self, template):
+ @staticmethod
+ def _cache_template(template):
"""Caches the title and body of a Template separately in memcache."""
memcache.set(_CACHED_TITLE_NAME % template.name, template.title)
memcache.set(_CACHED_BODY_NAME % template.name, template.body)
- def _cache_all_templates(self):
+ @staticmethod
+ def _cache_all_templates():
"""Fetches and caches all Template entities."""
- for template in Template.query().fetch():
- self._cache_template(template)
+ if not Template.cached_templates:
+ Template.cached_templates = Template.query().fetch()
+ for template in Template.cached_templates:
+ Template._cache_template(template)
+
+ @classmethod
+ def get(cls, name):
+ """Gets a Template by its name.
+
+ Args:
+ name: str, the name of the templatew.
+
+ Returns:
+ A Template model entity.
+ """
+ return cls.get_by_id(name)
+
+ @classmethod
+ def get_all(cls):
+ """Gets a list of objects stored in cache or datastore for this model."""
+ cls._cache_all_templates()
+ return cls.cached_templates
- def _get_subtemplate(self, sub_name):
+ @classmethod
+ def create(cls, name, title=None, body=None):
+ """Creates a model and entity."""
+ if not name:
+ raise datastore_errors.BadValueError(
+ 'The Template name must not be empty.')
+ entity = cls(title=title,
+ body=body)
+ template = cls.get_by_id(name)
+ if template is not None:
+ raise datastore_errors.BadValueError(
+ 'Create template: A Template entity with name %r already exists.' %
+ name)
+ entity.key = ndb.Key(cls, name)
+ entity.put()
+ logging.info('Creating a new template with name %r.', name)
+ cls.cached_templates = []
+ return entity
+
+ def update(self, name, title=None, body=None):
+ """updates a model's title or body given a name. clear cache."""
+ if not title and not body:
+ raise datastore_errors.BadValueError(
+ 'Title and body cannot both be empty.')
+ self.title = title
+ self.body = body
+ self.put()
+ logging.info('Updating a template with name %r.', name)
+ Template.cached_templates = []
+
+ def remove(self):
+ """delete a model instance."""
+ self.key.delete()
+ Template.cached_templates = []
+
+ def __eq__(self, other):
+ print('here')
+ print(self)
+ print(other)
+ return self.name == other.name
+
+ @staticmethod
+ def _get_subtemplate(sub_name):
"""Gets a template from memcache or datastore for the Jinja2 environment.
This gets either a sub-component of a Template entity (title or body).
@@ -93,10 +147,10 @@ def _get_subtemplate(self, sub_name):
Raises:
NoTemplateError: if the template with that sub-name does not exist.
"""
- if not self.templates_cached:
- self._cache_all_templates()
+
if sub_name.endswith('_base'):
sub_name = _CACHED_BODY_NAME % sub_name
+ Template._cache_all_templates()
cached_template = memcache.get(sub_name)
if cached_template:
return cached_template
@@ -107,7 +161,7 @@ def _get_subtemplate(self, sub_name):
if not stored_template:
raise NoTemplateError(
'Template named {} does not exist.'.format(sub_name))
- self._cache_template(stored_template)
+ Template._cache_template(stored_template)
return getattr(stored_template, match.group(1)) # 'title' or 'body'.
def render(self, name, config_dict):
diff --git a/loaner/web_app/backend/models/template_model_test.py b/loaner/web_app/backend/models/template_model_test.py
index 376bb8c6..7f7e65e2 100644
--- a/loaner/web_app/backend/models/template_model_test.py
+++ b/loaner/web_app/backend/models/template_model_test.py
@@ -20,6 +20,8 @@
import datetime
+from absl.testing import parameterized
+from google.appengine.api import datastore_errors
from google.appengine.api import memcache
from loaner.web_app.backend.models import template_model
from loaner.web_app.backend.testing import loanertest
@@ -35,16 +37,115 @@
'{% endblock %}')
-class TemplateTest(loanertest.TestCase):
+def _create_template_parameters():
+ """Creates a template list of parameters for parameterized test cases.
+
+ Yields:
+ A list containing values for template parameters
+ """
+ template_name_value = 'this_template'
+ body_value = 'body update test'
+ title_value = 'title update test'
+
+ template_parameters = [template_name_value, title_value, body_value]
+ yield [template_parameters]
+
+
+class TemplateTest(parameterized.TestCase, loanertest.TestCase):
"""Tests for the TemplateLoader class and Template model."""
+ def setUp(self):
+ super(TemplateTest, self).setUp()
+ self.template_model_1 = template_model.Template(
+ id='this_template', body='template body 1', title='title').put().get()
+ self.template_model_2 = template_model.Template(
+ id='second_template', body='template body 2',
+ title='title 2').put().get()
+
+ def test_get(self):
+ self.assertEqual(
+ template_model.Template.get('this_template'),
+ self.template_model_1)
+
+ def test_create_template_name_with_empty_string(self):
+ """Test the creation of a Template with an empty string."""
+ with self.assertRaises(datastore_errors.BadValueError):
+ template_model.Template.create(
+ name='',
+ title='test',
+ body='test')
+
+ def test_create_existing(self):
+ """Test the creation of an existing template."""
+ with self.assertRaises(datastore_errors.BadValueError):
+ template_model.Template.create(
+ name='this_template',
+ title='test')
+
+ def test_get_all_from_datastore(self):
+ templates = template_model.Template.get_all()
+ self.assertLen(templates, 2)
+
+ def test_get_all_from_memcache(self):
+ template_list = ['template1', 'template2', 'template3']
+ mem_name = 'template_list'
+ memcache.set(mem_name, template_list)
+ template_list_memcache = template_model.Template.get_all()
+ self.assertLen(template_list_memcache, 2)
+ memcache.flush_all()
+ reference_datastore_template_list = template_model.Template.get_all()
+ self.assertLen(reference_datastore_template_list, 2)
+
+ @parameterized.parameters(_create_template_parameters())
+ def test_remove(self, test_template):
+ self.template_model_2.remove()
+ entity_keys = template_model.Template.query().fetch()
+ entity_deleted = template_model.Template.get_by_id('second_template')
+ self.assertLen(entity_keys, 1)
+ self.assertEqual(entity_deleted, None)
+
+ @parameterized.parameters(_create_template_parameters())
+ def test_update(self, test_template):
+ self.template_model_1.update(
+ name=test_template[0], title=test_template[1], body=test_template[2])
+ updated_template = template_model.Template.get_by_id('this_template')
+ self.assertEqual(updated_template.name, test_template[0])
+ self.assertEqual(updated_template.title, test_template[1])
+ self.assertEqual(updated_template.body, test_template[2])
+
+ @parameterized.parameters(_create_template_parameters())
+ def test_update_one_field_empty(self, test_template):
+ self.template_model_1.update(
+ name=test_template[0], body=test_template[2])
+ updated_template = template_model.Template.get_by_id('this_template')
+ self.assertEqual(updated_template.name, test_template[0])
+ self.assertEqual(updated_template.body, test_template[2])
+
+ @parameterized.parameters(_create_template_parameters())
+ def test_update_failure(self, test_template):
+ with self.assertRaises(datastore_errors.BadValueError):
+ self.template_model_1.update(name=test_template[0])
+
+ @parameterized.parameters(_create_template_parameters())
+ def test_update_get_all(self, test_template):
+ update_template = template_model.Template(
+ id='this_template', body='body update test', title='title update test')
+ self.template_model_1.update(
+ name=update_template.name,
+ title=update_template.title,
+ body=update_template.body)
+ templates = template_model.Template.get_all()
+ index = templates.index(update_template)
+ self.assertEqual(templates[index].title, test_template[1])
+ self.assertEqual(templates[index].body, test_template[2])
+
def test_templates(self):
template = template_model.Template.create(
'loaner_due', title=TEST_TITLE, body=TEST_BODY)
self.assertEqual(template.name, 'loaner_due')
template_model.Template.create('reminder_base', body=TEST_BASE)
- template_loader = template_model.TemplateLoader()
+ template_loader = template_model.Template()
due_date = datetime.datetime(2017, 10, 13, 9, 31, 0, 0)
config_dict = {
@@ -76,5 +177,16 @@ def test_templates(self):
'want to see your pet turtle, Grumpy, again.'
'
-
- Maintain your loan
-
-
Please return this device by:
- {{ device.dueDate | date: 'fullDate' }}
-
+
+ Your loaner is due on {{ device.dueDate | date: 'fullDate' }}
+
+
+ Please return your loaner on time for your fellow colleague to use next.
+
+
+
+ Your loaner was due on {{ device.dueDate | date: 'fullDate' }}
+
+
+ Please return your loaner on time for your fellow colleague to use next.
+
+ This device should have been returned on:
- {{ device.dueDate | date: 'fullDate' }}
+
+
+ Your loaner is almost overdue {{ device.dueDate | date: 'fullDate' }}
+
+
+ Please return your loaner on time for your fellow colleague to use next.
+
+
@@ -32,10 +50,8 @@
-
+
diff --git a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.scss b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.scss
index 8b64a9bc..64fc30db 100644
--- a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.scss
+++ b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.scss
@@ -15,3 +15,15 @@ mat-card {
.date-container {
margin: 10px;
}
+
+.device-status {
+ padding: 10px;
+ height: 130px;
+ width: 130px;
+}
+
+.mat-overdue {
+ color: #e53935;
+ font-size: 20px;
+ font-style: bold;
+}
diff --git a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ts b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ts
index 2ee3c60c..26389116 100644
--- a/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ts
+++ b/loaner/shared/components/loan_management/loan_actions_card/loan_actions_card.ts
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-import {Component, ContentChild, Input} from '@angular/core';
+import {Component, ContentChild, DoCheck, Input, OnInit} from '@angular/core';
import {Device} from '../../../models/device';
@@ -56,11 +56,12 @@ import {GuestButton} from './guest_button';
styleUrls: ['./loan_actions_card.scss'],
templateUrl: './loan_actions_card.ng.html',
})
-export class LoanActionsCardComponent {
+export class LoanActionsCardComponent implements DoCheck, OnInit {
@Input() additionalManagementText = '';
@Input() device!: Device;
- @ContentChild(ExtendButton) extendButton!: ExtendButton;
- @ContentChild(GuestButton) guestButton!: GuestButton;
+ @ContentChild(ExtendButton, {static: true}) extendButton!: ExtendButton;
+ @ContentChild(GuestButton, {static: true}) guestButton!: GuestButton;
+ @Input() showImage = true; // Shows plant health icons.
ngOnInit() {
if (!this.device) {
diff --git a/loaner/shared/components/loan_management/loan_actions_card/material_module.ts b/loaner/shared/components/loan_management/loan_actions_card/material_module.ts
index ed048ff0..c83da42f 100644
--- a/loaner/shared/components/loan_management/loan_actions_card/material_module.ts
+++ b/loaner/shared/components/loan_management/loan_actions_card/material_module.ts
@@ -13,7 +13,12 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatCardModule, MatChipsModule, MatDialogModule, MatIconModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatChipsModule} from '@angular/material/chips';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatIconModule} from '@angular/material/icon';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/loan_management/loan_actions_card/return_button.ts b/loaner/shared/components/loan_management/loan_actions_card/return_button.ts
index a139ecf9..db9fb585 100644
--- a/loaner/shared/components/loan_management/loan_actions_card/return_button.ts
+++ b/loaner/shared/components/loan_management/loan_actions_card/return_button.ts
@@ -23,6 +23,7 @@ import {Subject} from 'rxjs';
color="primary"
(click)="returnDevice()"
[disabled]="disabled"
+ id="return"
aria-label="Click to start the return process for this device.
This will close the current window and open the return window.">
Return
diff --git a/loaner/shared/components/loaner_date_adapter/LoanerDateAdapter.ts b/loaner/shared/components/loaner_date_adapter/LoanerDateAdapter.ts
index 6188f129..db5e5033 100644
--- a/loaner/shared/components/loaner_date_adapter/LoanerDateAdapter.ts
+++ b/loaner/shared/components/loaner_date_adapter/LoanerDateAdapter.ts
@@ -41,7 +41,7 @@ export class LoanerDateAdapter extends NativeDateAdapter {
'December',
];
format(date: Date, displayFormat: {}): string {
- return `${this.monthNames[date.getUTCMonth()]} ${date.getUTCDate()}, ${
- date.getUTCFullYear()}`;
+ return `${this.monthNames[date.getMonth()]} ${date.getDate()}, ${
+ date.getFullYear()}`;
}
}
diff --git a/loaner/shared/components/lost/lost.ts b/loaner/shared/components/lost/lost.ts
index 33a28e86..77f7c4b4 100644
--- a/loaner/shared/components/lost/lost.ts
+++ b/loaner/shared/components/lost/lost.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/lost/lost_test.ts b/loaner/shared/components/lost/lost_test.ts
index 4615195f..c8f9bcb7 100644
--- a/loaner/shared/components/lost/lost_test.ts
+++ b/loaner/shared/components/lost/lost_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogRef} from '@angular/material';
+import {MatDialogRef} from '@angular/material/dialog';
import {LostDialogComponent, LostModule} from './index';
diff --git a/loaner/shared/components/lost/material_module.ts b/loaner/shared/components/lost/material_module.ts
index 612de8fa..0fa0a307 100644
--- a/loaner/shared/components/lost/material_module.ts
+++ b/loaner/shared/components/lost/material_module.ts
@@ -13,7 +13,11 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatInputModule, MatRippleModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
+import {MatInputModule} from '@angular/material/input';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/progress/material_module.ts b/loaner/shared/components/progress/material_module.ts
index fdbdaf62..c3049880 100644
--- a/loaner/shared/components/progress/material_module.ts
+++ b/loaner/shared/components/progress/material_module.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatProgressBarModule} from '@angular/material';
+import {MatProgressBarModule} from '@angular/material/progress-bar';
const MATERIAL_MODULES = [MatProgressBarModule];
diff --git a/loaner/shared/components/progress/progress_test.ts b/loaner/shared/components/progress/progress_test.ts
index 18d16fee..7ac4efba 100644
--- a/loaner/shared/components/progress/progress_test.ts
+++ b/loaner/shared/components/progress/progress_test.ts
@@ -14,7 +14,6 @@
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {FlexLayoutModule} from '@angular/flex-layout';
-import {By} from '@angular/platform-browser';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {ProgressComponent} from './index';
@@ -46,10 +45,10 @@ describe('Shared ProgressComponent', () => {
it('should set the app progress to 25', () => {
app.current = 1;
app.max = 4;
- const element =
- fixture.debugElement.query(By.css('mat-progress-bar')).attributes;
fixture.detectChanges();
expect(app.progress).toBe(25);
- expect(element['aria-valuenow']).toBe('25');
+ expect(fixture.debugElement.nativeElement.querySelector('mat-progress-bar')
+ .getAttribute('aria-valuenow'))
+ .toBe('25');
});
});
diff --git a/loaner/shared/components/resume_loan/material_module.ts b/loaner/shared/components/resume_loan/material_module.ts
index fbe8ebec..cc6e922a 100644
--- a/loaner/shared/components/resume_loan/material_module.ts
+++ b/loaner/shared/components/resume_loan/material_module.ts
@@ -13,7 +13,9 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatDialogModule, MatRippleModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatRippleModule} from '@angular/material/core';
+import {MatDialogModule} from '@angular/material/dialog';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/resume_loan/resume_loan.ts b/loaner/shared/components/resume_loan/resume_loan.ts
index 5175279b..a47e21b0 100644
--- a/loaner/shared/components/resume_loan/resume_loan.ts
+++ b/loaner/shared/components/resume_loan/resume_loan.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, Injectable} from '@angular/core';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {Subject} from 'rxjs';
import {LoaderView} from '../loader';
diff --git a/loaner/shared/components/resume_loan/resume_loan_test.ts b/loaner/shared/components/resume_loan/resume_loan_test.ts
index 580e3b1a..f606c78f 100644
--- a/loaner/shared/components/resume_loan/resume_loan_test.ts
+++ b/loaner/shared/components/resume_loan/resume_loan_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialogModule, MatDialogRef} from '@angular/material';
+import {MatDialogModule, MatDialogRef} from '@angular/material/dialog';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {LoaderModule} from '../loader';
diff --git a/loaner/shared/components/return_instructions/material_module.ts b/loaner/shared/components/return_instructions/material_module.ts
index 7aa4905a..17808b16 100644
--- a/loaner/shared/components/return_instructions/material_module.ts
+++ b/loaner/shared/components/return_instructions/material_module.ts
@@ -13,7 +13,10 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatCardModule, MatIconModule, MatTooltipModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatIconModule} from '@angular/material/icon';
+import {MatTooltipModule} from '@angular/material/tooltip';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/return_instructions/return_instructions.ts b/loaner/shared/components/return_instructions/return_instructions.ts
index 90983991..e205ac53 100644
--- a/loaner/shared/components/return_instructions/return_instructions.ts
+++ b/loaner/shared/components/return_instructions/return_instructions.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {Component, ElementRef, Input, OnInit, ViewChild} from '@angular/core';
-import {MatDialog} from '@angular/material';
+import {MatDialog} from '@angular/material/dialog';
import {AnimationMenuService} from '../../services/animation_menu_service';
import {AnimationMenuComponent} from '../animation_menu';
@@ -31,7 +31,7 @@ export enum FlowsEnum {
templateUrl: './return_instructions.ng.html',
})
export class LoanerReturnInstructions implements OnInit {
- @ViewChild('returnAnimation') animationElement!: ElementRef;
+ @ViewChild('returnAnimation', {static: false}) animationElement!: ElementRef;
flows = FlowsEnum;
diff --git a/loaner/shared/components/return_instructions/return_instructions_test.ts b/loaner/shared/components/return_instructions/return_instructions_test.ts
index b0e5f8b0..4dd83cf7 100644
--- a/loaner/shared/components/return_instructions/return_instructions_test.ts
+++ b/loaner/shared/components/return_instructions/return_instructions_test.ts
@@ -13,7 +13,7 @@
// limitations under the License.
import {async, ComponentFixture, TestBed} from '@angular/core/testing';
-import {MatDialog, MatDialogRef} from '@angular/material';
+import {MatDialog, MatDialogRef} from '@angular/material/dialog';
import {AnimationMenuService} from '../../services/animation_menu_service';
import {AnimationMenuServiceMock} from '../../testing/mocks';
diff --git a/loaner/shared/components/survey/material_module.ts b/loaner/shared/components/survey/material_module.ts
index 83b8569a..5ffec70a 100644
--- a/loaner/shared/components/survey/material_module.ts
+++ b/loaner/shared/components/survey/material_module.ts
@@ -13,7 +13,10 @@
// limitations under the License.
import {NgModule} from '@angular/core';
-import {MatButtonModule, MatCardModule, MatInputModule, MatRadioModule} from '@angular/material';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatInputModule} from '@angular/material/input';
+import {MatRadioModule} from '@angular/material/radio';
const MATERIAL_MODULES = [
MatButtonModule,
diff --git a/loaner/shared/components/survey/survey_component.ts b/loaner/shared/components/survey/survey_component.ts
index 531bffeb..621aece7 100644
--- a/loaner/shared/components/survey/survey_component.ts
+++ b/loaner/shared/components/survey/survey_component.ts
@@ -65,7 +65,7 @@ export class SurveyComponent extends LoaderView implements OnInit {
const answer: SurveyAnswer = {
question_urlsafe_key: this.surveyData.question_urlsafe_key,
selected_answer: this.surveyAnswer,
- more_info_text: e,
+ more_info_text: (typeof e === 'string') ? e : undefined
};
this.survey.answer.next(answer);
}
diff --git a/loaner/shared/components/survey/survey_component_test.ts b/loaner/shared/components/survey/survey_component_test.ts
index 56ad381c..563c29cc 100644
--- a/loaner/shared/components/survey/survey_component_test.ts
+++ b/loaner/shared/components/survey/survey_component_test.ts
@@ -17,8 +17,7 @@ import {HttpClientModule} from '@angular/common/http';
import {DebugElement} from '@angular/core';
import {ComponentFixture, TestBed} from '@angular/core/testing';
import {FormsModule} from '@angular/forms';
-import {MatRadioButton} from '@angular/material';
-import {By} from '@angular/platform-browser';
+import {MatRadioButton} from '@angular/material/radio';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';
import {ApiConfig, apiConfigFactory} from '../../services/api_config';
@@ -32,11 +31,6 @@ describe('SurveyComponent', () => {
let app: SurveyComponent;
let fixture: ComponentFixture