Run dartdoc for the given task. Related issue: #227. (#322)

Author: isoos

app/lib/dartdoc/dartdoc_runner.dart

@@ -3,14 +3,23 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
 
 import 'package:logging/logging.dart';
+// TODO: export library in pana
+import 'package:pana/src/sdk_env.dart';
+import 'package:path/path.dart' as p;
 
 import '../shared/task_scheduler.dart' show Task, TaskRunner;
 
 final Logger _logger = new Logger('pub.dartdoc.runner');
 
+const metadataFilePath = 'doc/api/pub-dartlang-metadata.json';
+
 class DartdocRunner implements TaskRunner {
+  String _cachedDartdocVersion;
+
   @override
   Future<bool> hasCompletedRecently(Task task) async {
     // TODO: implement a metadata check
@@ -19,7 +28,82 @@ class DartdocRunner implements TaskRunner {
 
   @override
   Future<bool> runTask(Task task) async {
-    // TODO: implement doc generation and upload
-    return false; // no race detected
+    final tempDir =
+        await Directory.systemTemp.createTemp('pub-dartlang-dartdoc');
+    final tempDirPath = tempDir.resolveSymbolicLinksSync();
+    final pubCacheDir = p.join(tempDirPath, 'pub-cache');
+    final outputDir = p.join(tempDirPath, 'output');
+
+    final pubEnv = new PubEnvironment(pubCacheDir: pubCacheDir);
+
+    try {
+      // TODO: use direct link to download the package
+      final pkgLocation =
+          await pubEnv.getLocation(task.package, version: task.version);
+      final pkgPath = pkgLocation.location;
+
+      // resolve dependencies
+      await pubEnv.runUpgrade(pkgPath, /* isFlutter */ false);
+
+      await _generateDocs(task, pkgPath, outputDir);
+
+      await _writeMetadata(task, pkgPath);
+
+      // TODO: upload doc/api to the appropriate bucket
+    } finally {
+      await tempDir.delete(recursive: true);
+    }
+    return false; // no race detection
+  }
+
+  Future _generateDocs(Task task, String pkgPath, String outputDir) async {
+    final pr = await Process.run(
+      'dartdoc',
+      ['--output', outputDir],
+      workingDirectory: pkgPath,
+    );
+    if (pr.exitCode != 0) {
+      _logger.severe('Error while running dartdoc for $task.\n'
+          'exitCode: ${pr.exitCode}\n'
+          'stdout: ${pr.stdout}\n'
+          'stderr: ${pr.stderr}\n');
+      throw new Exception('dartdoc execution failed with code ${pr.exitCode}');
+    }
+  }
+
+  Future _writeMetadata(Task task, String pkgPath) async {
+    await new File(p.join(pkgPath, metadataFilePath))
+        .writeAsString(JSON.encode({
+      'package': task.package,
+      'version': task.version,
+      'dartdoc': await _getDartdocVersion(),
+      'timestamp': new DateTime.now().toUtc().toIso8601String(),
+    }));
+  }
+
+  Future<String> _getDartdocVersion() async {
+    if (_cachedDartdocVersion != null) return _cachedDartdocVersion;
+    final pr = await Process.run('dartdoc', ['--version']);
+    if (pr.exitCode != 0) {
+      _logger.severe('Unable to detect dartdoc version\n'
+          'exitCode: ${pr.exitCode}\n'
+          'stdout: ${pr.stdout}\n'
+          'stderr: ${pr.stderr}\n');
+      throw new Exception('dartdoc execution failed with code ${pr.exitCode}');
+    }
+
+    final match = _versionRegExp.firstMatch(pr.stdout);
+    if (match == null) {
+      _logger.severe('Unable to parse dartdoc version: ${pr.stdout}');
+      throw new Exception('Unable to parse dartdoc version: ${pr.stdout}');
+    }
+
+    final version = match.group(1).trim();
+    if (version.isNotEmpty) {
+      _cachedDartdocVersion = version;
+    }
+    return _cachedDartdocVersion;
   }
 }
+
+final RegExp _versionRegExp = new RegExp(r'dartdoc version: (.*)$');